Class Stream<T, ClientType>

Stream implements an Asynchronous Iterable over messages received from a topic. As such can be used with constructs like for-await-of, yield*, array destructing, etc.

Type Parameters

  • T
  • ClientType = any



callback: undefined | ((env) => Promise<void>)

Type declaration

    • (env): Promise<void>
    • Parameters

      • env: Envelope

      Returns Promise<void>

messages: T[]
onConnectionLost?: OnConnectionLostCallback
resolvers: ((value) => void)[]

Type declaration

    • (value): void
    • Parameters

      • value: IteratorResult<T, any>

      Returns void

subscriptionManager?: SubscriptionManager
topics: string[]


  • Returns AsyncIterableIterator<T>

  • Returns Promise<IteratorResult<T, any>>

  • Returns Promise<IteratorResult<T, any>>

Generated using TypeDoc