redis-x-stream / Exports / RedisStream
- ackOnIterate
- block
- blocked
- buffers
- client
- consumer
- control
- count
- deleteOnAck
- done
- draining
- first
- group
- noack
- pendingAcks
- streams
• new RedisStream(options, ...streams)
| Name | Type |
|---|---|
options |
string | RedisStreamOptions |
...streams |
string[] |
• ackOnIterate: boolean = false
• Optional block: number
• Readonly blocked: boolean = false
• buffers: boolean = false
• Readonly client: Redis
• Optional Readonly consumer: string
• Optional Readonly control: Redis
• count: number = 100
• deleteOnAck: boolean = false
• done: boolean = false
Flag for iterable state
• draining: boolean = false
• first: boolean = false
• Optional Readonly group: string
• noack: boolean = false
• pendingAcks: Map<string, string[]>
Acks waiting to be sent on either:
- interval
- async iteration
• streams: Map<string, string>
▸ [asyncIterator](): AsyncIterator<XEntryResult, any, undefined>
AsyncIterator<XEntryResult, any, undefined>
▸ ack(stream, ...ids): undefined
| Name | Type |
|---|---|
stream |
string |
...ids |
string[] |
undefined
▸ addStream(streamName): Promise<void>
| Name | Type |
|---|---|
streamName |
string |
Promise<void>
▸ drain(): Promise<void>
Iterate through remaining items in the PEL and exit
Promise<void>
▸ end(): Promise<void>
Immediately stop processing entries
Promise<void>
▸ quit(): Promise<void>
Promise<void>
▸ Protected return(): Promise<void>
Promise<void>