Variable updateStream

Type Declaration

• • (
        id?: any,
        asked?: any,
        mode?: any,
        context?: any,
    ):
        | { errors: any[]; ok: boolean; stream: any }
        | { errors: any[]; ok: boolean; stream: any }

  • Updates a stream's configuration: replace (PUT) takes every receiver-settable member from the body and resets the omitted ones; merge (PATCH) changes only the members present.

    A transmitter-supplied member may be sent only with the value it already has.

    Parameters

    • Optionalid: any

      the stream_id

    • Optionalasked: any

      the Stream Configuration sent

    • Optionalmode: any

      replace or merge

    • Optionalcontext: any

      the caller's context, as createStream() takes it

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

    { ok, stream, errors }