Variable setStatus

Type Declaration

• • (
        id?: any,
        status?: any,
        reason?: any,
    ):
        | { errors: string[]; ok: boolean; stream: any }
        | { errors: any[]; ok: boolean; stream: any }

  • Sets a stream's status: enabled, paused (it keeps queueing and delivers nothing) or disabled (it drops what is queued).

    Parameters

    • Optionalid: any

      the stream_id

    • Optionalstatus: any

      the new status

    • Optionalreason: any

      why, for the stream's log and the stream-updated event

    Returns
        | { errors: string[]; ok: boolean; stream: any }
        | { errors: any[]; ok: boolean; stream: any }

    { ok, stream, errors }