Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Stream<T, ClientType>(client: Client<ClientType>, topics: string[], decoder: MessageDecoder<T>, contentTopicUpdater?: ContentTopicUpdater<T>, onConnectionLost?: OnConnectionLostCallback): Stream<T, ClientType>

  • 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: Envelope) => Promise<void>)

client

client: Client<ClientType>

messages

messages: T[]

Optional onConnectionLost

onConnectionLost?: OnConnectionLostCallback

resolvers

resolvers: ((value: IteratorResult<T, any>) => void)[]

Optional subscriptionManager

subscriptionManager?: SubscriptionManager

topics

topics: string[]

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<T>

next

  • next(): Promise<IteratorResult<T, any>>

return

  • return(): Promise<IteratorResult<T, any>>

Static create

  • create<T, ClientType>(client: Client<ClientType>, topics: string[], decoder: MessageDecoder<T>, contentTopicUpdater?: ContentTopicUpdater<T>, onConnectionLost?: OnConnectionLostCallback): Promise<Stream<T, ClientType>>

  • 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>>

Generated using TypeDoc