Class StreamClient<T>

constructor

• new StreamClient<T>(token, clientConfiguration): StreamClient<T>

• Type Parameters

  • T extends QueryValue = any

  Parameters

  • token: StreamToken | (() => Promise<StreamToken>)
  • clientConfiguration: StreamClientConfiguration

    The ClientConfiguration to apply

  Returns StreamClient<T>

  Example

   const streamClient = client.stream(streamToken);
  Copy

closed

last_ts

• get last_ts(): undefined | number

• Returns undefined | number

[asyncIterator]

• [asyncIterator](): AsyncGenerator<StreamEventData<T> | StreamEventStatus, any, unknown>

• Returns AsyncGenerator<StreamEventData<T> | StreamEventStatus, any, unknown>

close

• close(): void

• Returns void

start

• start(onEvent, onError?): void

• A synchronous method to start listening to the stream and handle events using callbacks.

  Parameters

  • onEvent: ((event: StreamEventData<T> | StreamEventStatus) => void)

    A callback function to handle each event

    • • (event): void

      • Parameters

        • event: StreamEventData<T> | StreamEventStatus

        Returns void

  • OptionalonError: ((error: Error) => void)

    An Optional callback function to handle errors. If none is provided, error will not be handled, and the stream will simply end.

    • • (error): void

      • Parameters

        • error: Error

        Returns void

  Returns void