Interface Stream

interface Stream {
    name: string;
    alternates(): Promise<StreamAlternate[]>;
    best(): Promise<Stream>;
    deleteMessage(seq: number, erase?: boolean): Promise<boolean>;
    getConsumer(name?: string | Partial<OrderedConsumerOptions>): Promise<Consumer>;
    getMessage(query: MsgRequest): Promise<StoredMsg>;
    info(cached?: boolean, opts?: Partial<StreamInfoRequestOptions>): Promise<StreamInfo>;
}

Index

Properties

Methods

alternates best deleteMessage getConsumer getMessage info

Properties

name

name: string

Methods

alternates

alternates(): Promise<StreamAlternate[]>
Returns Promise<StreamAlternate[]>
- Defined in build/src/types.ts:1192

best

best(): Promise<Stream>
Returns Promise<Stream>
- Defined in build/src/types.ts:1194

deleteMessage

deleteMessage(seq, erase?): Promise<boolean>
Parameters
- seq: number
- Optionalerase: boolean
Returns Promise<boolean>
- Defined in build/src/types.ts:1202

getConsumer

getConsumer(name?): Promise<Consumer>
Parameters
- Optionalname: string | Partial<OrderedConsumerOptions>
Returns Promise<Consumer>
- Defined in build/src/types.ts:1196

getMessage

getMessage(query): Promise<StoredMsg>
Parameters
- query: MsgRequest
Returns Promise<StoredMsg>
- Defined in build/src/types.ts:1200

info

info(cached?, opts?): Promise<StreamInfo>
Parameters
- Optionalcached: boolean
- Optionalopts: Partial<StreamInfoRequestOptions>
Returns Promise<StreamInfo>
- Defined in build/src/types.ts:1187