Type Alias Stream

Type declaration

• name: string

• alternates:function

  • alternates(): Promise<StreamAlternate[]>

    Returns Promise<StreamAlternate[]>

• best:function

  • best(): Promise<Stream>

    Returns Promise<Stream>

• deleteMessage:function

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

    Parameters

    • seq: number
    • Optionalerase: boolean

    Returns Promise<boolean>

• getConsumer:function

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

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

    Parameters

    • query: MsgRequest

    Returns Promise<StoredMsg>

• getPushConsumer:function

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

    Parameters

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

    Returns Promise<PushConsumer>

• info:function

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

    Parameters

    • Optionalcached: boolean
    • Optionalopts: Partial<StreamInfoRequestOptions>

    Returns Promise<StreamInfo>