Interface ConsumerAPI

Hierarchy

ConsumerAPI

Index

Methods

add delete info list pause resume update

Methods

add

add(stream: string, cfg: Partial<ConsumerConfig>): Promise<ConsumerInfo>
Adds a new consumer to the specified stream with the specified consumer options.
Parameters
- stream: string
- cfg: Partial<ConsumerConfig>
Returns Promise<ConsumerInfo>
- Defined in cjs/jetstream/jsmconsumer_api.ts:52

delete

delete(stream: string, consumer: string): Promise<boolean>
Deletes the specified consumer name/durable from the specified stream.
Parameters
- stream: string
- consumer: string
Returns Promise<boolean>
- Defined in cjs/jetstream/jsmconsumer_api.ts:72

info

info(stream: string, consumer: string): Promise<ConsumerInfo>
Returns the ConsumerInfo for the specified consumer in the specified stream.
Parameters
- stream: string
- consumer: string
Returns Promise<ConsumerInfo>
- Defined in cjs/jetstream/jsmconsumer_api.ts:45

list

list(stream: string): Lister<ConsumerInfo>
Lists all the consumers on the specfied streams
Parameters
- stream: string
Returns Lister<ConsumerInfo>
- Defined in cjs/jetstream/jsmconsumer_api.ts:78

pause

pause(stream: string, name: string, until?: Date): Promise<{
pause_until?: string;
paused: boolean;
}>
Parameters
- stream: string
- name: string
- Optional until: Date
Returns Promise<{
pause_until?: string;
paused: boolean;
}>
- Defined in cjs/jetstream/jsmconsumer_api.ts:80

resume

resume(stream: string, name: string): Promise<{
pause_until?: string;
paused: boolean;
}>
Parameters
- stream: string
- name: string
Returns Promise<{
pause_until?: string;
paused: boolean;
}>
- Defined in cjs/jetstream/jsmconsumer_api.ts:86

update

update(stream: string, durable: string, cfg: Partial<ConsumerUpdateConfig>): Promise<ConsumerInfo>
Updates the consumer configuration for the specified consumer on the specified stream that has the specified durable name.
Parameters
- stream: string
- durable: string
- cfg: Partial<ConsumerUpdateConfig>
Returns Promise<ConsumerInfo>
- Defined in cjs/jetstream/jsmconsumer_api.ts:61

Generated using TypeDoc