Interface StreamAPI

Hierarchy

StreamAPI

Index

Methods

add delete deleteMessage find get getMessage info list listKvs listObjectStores names purge update

Methods

add

add(cfg: Partial<StreamConfig>): Promise<StreamInfo>
Adds a new stream with the specified stream configuration.
Parameters
- cfg: Partial<StreamConfig>
Returns Promise<StreamInfo>
- Defined in cjs/jetstream/types.ts:217

delete

delete(stream: string): Promise<boolean>
Deletes the specified stream
Parameters
- stream: string
Returns Promise<boolean>
- Defined in cjs/jetstream/types.ts:237

deleteMessage

deleteMessage(stream: string, seq: number, erase?: boolean): Promise<boolean>
Deletes the specified message sequence from the stream
Parameters
- stream: string
- seq: number
- Optional erase: boolean
  
  erase the message - by default true
Returns Promise<boolean>
- Defined in cjs/jetstream/types.ts:251

find

find(subject: string): Promise<string>
Find the stream that stores the specified subject.
Parameters
- subject: string
Returns Promise<string>
- Defined in cjs/jetstream/types.ts:265

get

get(name: string): Promise<Stream>
Returns a Stream object
Parameters
- name: string
Returns Promise<Stream>
- Defined in cjs/jetstream/types.ts:290

getMessage

getMessage(stream: string, query: MsgRequest): Promise<StoredMsg>
Retrieves the message matching the specified query. Messages can be retrieved by sequence number or by last sequence matching a subject.
Parameters
- stream: string
- query: MsgRequest
Returns Promise<StoredMsg>
- Defined in cjs/jetstream/types.ts:259

info

info(stream: string, opts?: Partial<StreamInfoRequestOptions>): Promise<StreamInfo>
Returns the information about the specified stream
Parameters
- stream: string
- Optional opts: Partial<StreamInfoRequestOptions>
Returns Promise<StreamInfo>
- Defined in cjs/jetstream/types.ts:208

list

list(subject?: string): Lister<StreamInfo>
Lists all streams stored by JetStream
Parameters
- Optional subject: string
  
  only return streams that include the specified subject
Returns Lister<StreamInfo>
- Defined in cjs/jetstream/types.ts:243

listKvs

listKvs(): Lister<KvStatus>
Returns a list of KvStatus for all streams that are identified as being a KV (that is having names that have the prefix KV_)

Returns Lister<KvStatus>
- Defined in cjs/jetstream/types.ts:271

listObjectStores

listObjectStores(): Lister<ObjectStoreStatus>
Returns a list of ObjectStoreInfo for all streams that are identified as being a ObjectStore (that is having names that have the prefix OBJ_)

Returns Lister<ObjectStoreStatus>
- Defined in cjs/jetstream/types.ts:277

names

names(subject?: string): Lister<string>
Return a Lister of stream names
Parameters
- Optional subject: string
  
  if specified, the results are filtered to streams that contain the subject (can be wildcarded)
Returns Lister<string>
- Defined in cjs/jetstream/types.ts:284

purge

purge(stream: string, opts?: PurgeOpts): Promise<PurgeResponse>
Purges messages from a stream that match the specified purge options.
Parameters
- stream: string
- Optional opts: PurgeOpts
Returns Promise<PurgeResponse>
- Defined in cjs/jetstream/types.ts:231

update

update(name: string, cfg: Partial<StreamUpdateConfig>): Promise<StreamInfo>
Updates the stream configuration for the specified stream.
Parameters
- name: string
- cfg: Partial<StreamUpdateConfig>
Returns Promise<StreamInfo>
- Defined in cjs/jetstream/types.ts:224

Generated using TypeDoc