Class Stream<T, ClientType>

constructor

• new Stream<T, ClientType>(client, topics, decoder, contentTopicUpdater?, onConnectionLost?): 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>

callback

client

messages

Optional onConnectionLost

resolvers

Optional subscriptionManager

topics

[asyncIterator]

• [asyncIterator](): AsyncIterableIterator<T>

• Returns AsyncIterableIterator<T>

next

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

• Returns Promise<IteratorResult<T, any>>

return

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

• Returns Promise<IteratorResult<T, any>>

Static create

• create<T, ClientType>(client, topics, decoder, contentTopicUpdater?, onConnectionLost?): 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>>