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

Hierarchy

  • Stream

Constructors

constructor

Properties

callback client messages onConnectionLost? resolvers subscriptionManager? topics

Methods

[asyncIterator] next return create

Constructors

constructor

  • Type Parameters

    • T

    • ClientType = any

    Parameters

    • client: Client<ClientType>
    • topics: string[]
    • decoder: MessageDecoder<T>
    • Optional contentTopicUpdater: ContentTopicUpdater<T>
    • Optional onConnectionLost: OnConnectionLostCallback

    Returns Stream<T, ClientType>

Properties

callback

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

Type declaration

    • (env): Promise<void>

    • Parameters

      • env: Envelope

      Returns Promise<void>

client

client: Client<ClientType>

messages

messages: T[]

Optional onConnectionLost

onConnectionLost?: OnConnectionLostCallback

resolvers

resolvers: ((value) => void)[]

Type declaration

    • (value): void

    • Parameters

      • value: IteratorResult<T, any>

      Returns void

Optional subscriptionManager

subscriptionManager?: SubscriptionManager

topics

topics: string[]

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<T>

  • Returns AsyncIterableIterator<T>

next

  • Returns Promise<IteratorResult<T, any>>

return

  • Returns Promise<IteratorResult<T, any>>

Static create

  • Type Parameters

    • T

    • ClientType = string

    Parameters

    • client: Client<ClientType>
    • topics: string[]
    • decoder: MessageDecoder<T>
    • Optional contentTopicUpdater: ContentTopicUpdater<T>
    • Optional onConnectionLost: OnConnectionLostCallback

    Returns Promise<Stream<T, ClientType>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc