Type Alias Stream

name

alternates

• alternates(): Promise<StreamAlternate[]>

  Returns Promise<StreamAlternate[]>

best

• best(): Promise<Stream>

  Returns Promise<Stream>

deleteMessage

• deleteMessage(seq: number, erase?: boolean): Promise<boolean>

  Parameters

  • seq: number
  • Optionalerase: boolean

  Returns Promise<boolean>

getConsumer

• getConsumer(name?: string | Partial<OrderedConsumerOptions>): Promise<Consumer>

  Returns the named consumer pull consumer. If instead of a name an OrderedConsumerOptions configuration is passed, an ordered pull consumer is created and returned.

  Parameters

  • Optionalname: string | Partial<OrderedConsumerOptions>

  Returns Promise<Consumer>

getMessage

• getMessage(query: MsgRequest): Promise<StoredMsg>

  Parameters

  • query: MsgRequest

  Returns Promise<StoredMsg>

getPushConsumer

• getPushConsumer(
      stream: string,
      name?: string | Partial<OrderedPushConsumerOptions>,
  ): Promise<PushConsumer>

  Parameters

  • stream: string
  • Optionalname: string | Partial<OrderedPushConsumerOptions>

  Returns Promise<PushConsumer>

info

• info(
      cached?: boolean,
      opts?: Partial<StreamInfoRequestOptions>,
  ): Promise<StreamInfo>

  Parameters

  • Optionalcached: boolean
  • Optionalopts: Partial<StreamInfoRequestOptions>

  Returns Promise<StreamInfo>