Type Alias Stream

name

alternates

• alternates(): Promise<StreamAlternate[]>

  Returns a list of streams that are equivalent alternates to this one.

  Returns Promise<StreamAlternate[]>

best

• best(): Promise<Stream>

  Return the alternate (best RRT) for this stream. This is the first alternate returned by the server.

  Returns Promise<Stream>

deleteMessage

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

  Deletes the specified message sequence

  Parameters

  • seq: number
  • Optionalerase: boolean

    default is true

  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>

  Retrieves the specified message using the specified query.

  Parameters

  • query: MsgRequest

  Returns Promise<StoredMsg>

getPushConsumer

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

  Returns the specified push consumer.

  Parameters

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

    the name of the consumer, or an ordered consumer specification.

  Returns Promise<PushConsumer>

info

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

  Returns the info (optionally cached) on the stream.

  Parameters

  • Optionalcached: boolean
  • Optionalopts: Partial<StreamInfoRequestOptions>

  Returns Promise<StreamInfo>

resetConsumer

• resetConsumer(name: string, seq?: number): Promise<ConsumerResetResponse>

  Resets the named consumer's delivery state. See ConsumerAPI.reset for the underlying behavior, version requirements, and policy constraints.

  IMPORTANT: this is an admin operation. In-flight consume(), fetch(), next(), or push subscriptions on the consumer are NOT coordinated by this call. Buffered messages from the prior delivery may still be yielded, and re-delivered messages will have a delivery sequence restarting from 1 — looking like a gap. Ordered consumers detect the gap and recreate themselves; non-ordered consumers should be stopped and restarted by the caller after a reset.

  Parameters

  • name: string

    consumer name or durable

  • Optionalseq: number

    optional stream sequence to reset to

  Returns Promise<ConsumerResetResponse>