redis-x-stream / Exports / RedisStreamOptions
- ackOnIterate
- block
- buffers
- consumer
- count
- deleteOnAck
- flushPendingAckInterval
- group
- noack
- redis
- redisControl
- streams
• Optional ackOnIterate: boolean
If set to true Iterables utilizing consumer groups will
automatically queue acknowledgments for previously iterated entries.
Default
false
• Optional block: number
The longest amount of time in milliseconds the dispenser should block while waiting for new entries on any stream, passed to xread or xreadgroup
• Optional buffers: boolean
Return buffers with each xread operation This applies to entry id and kv results
• Optional consumer: string
The consumer. Note: if only consumer is provided, a group is created automatically
• Optional count: number
The maximum number of entries to retrieve in a single read operation eg. the "highWaterMark"
Default
100
• Optional deleteOnAck: boolean
If set to true Iterables utilizing consumer groups will
automatically delete entries after acknowledgment
Default
false
• Optional flushPendingAckInterval: number
If iteration is slow, set this to the maximum amount of time that should elapse before pending acks will be flushed This counter is reset after each iteration or ack
TODO: not yet implemented
• Optional group: string
The consumer group. Note: if only a group is provided a consumer is created automatically
• Optional noack: boolean
Pass the NOACK flag to calls to xreadgroup bypassing the Redis PEL
Default
false
• Optional redis: string | Redis | RedisOptions
The IORedis client connection (reader). NOTE: by default this connection becomes a "reader" when block > 0
• Optional redisControl: string | Redis | RedisOptions
The IORedis control client connection (writer). NOTE: by default this connection becomes a "writer" when block = 0 or Infinity Only allowed if block = 0 or Infinity
• streams: Record<string, string> | string[]
Redis stream keys to be read. If a Record is provided each value is the starting id for that stream