fix: cursor + block for xreadgroup

Author: calebboyd

README.md

@@ -8,24 +8,13 @@ Requires Redis 5 or greater.
 ```javascript
 import { RedisStream } from 'redis-x-stream'
 
-for await (const [stream, entry] of new RedisStream('myStream')) {
+for await (const [stream, [id, keyvals]] of new RedisStream('myStream')) {
   //process an entry
 }
 ```
-
 ## Usage
 
 See [API Docs](docs/classes/redisstream.md#constructor)
-
-## TODO
-- [x] ~xread batch~
-- [x] ~xread stream~
-- [x] ~xread entry~
-- [x] ~xreadgroup entry~
-- [ ] xreadgroup stream
-- [ ] xreadgroup batch
-- [ ] documentation
-
-## Maybe TODO
-- [ ] eager load?
-- [ ] Controller for UNBLOCK on .quit
+## Not yet implemented
+- batch mode
+- stream mode

docs/README.md

@@ -10,24 +10,13 @@ Requires Redis 5 or greater.
 ```javascript
 import { RedisStream } from 'redis-x-stream'
 
-for await (const [stream, entry] of new RedisStream('myStream')) {
+for await (const [stream, [id, keyvals]] of new RedisStream('myStream')) {
   //process an entry
 }
 ```
-
 ## Usage
 
 See [API Docs](docs/classes/redisstream.md#constructor)
-
-## TODO
-- [x] xread batch
-- [x] xread stream
-- [x] xread entry
-- [x] xreadgroup entry
-- [ ] xreadgroup stream
-- [ ] xreadgroup batch
-- [ ] documentation
-
-## Maybe TODO
-- [ ] eager load?
-- [ ] Controller for UNBLOCK on .quit
+## Not yet implemented
+- batch mode
+- stream mode

docs/classes/redisstream.md

@@ -22,10 +22,10 @@ Name | Type | Default |
 
 * [ackOnIterate](redisstream.md#ackoniterate)
 * [block](redisstream.md#block)
+* [buffers](redisstream.md#buffers)
 * [client](redisstream.md#client)
 * [consumer](redisstream.md#consumer)
 * [count](redisstream.md#count)
-* [createdConnection](redisstream.md#createdconnection)
 * [deleteOnAck](redisstream.md#deleteonack)
 * [done](redisstream.md#done)
 * [first](redisstream.md#first)
@@ -63,65 +63,63 @@ Name | Type |
 
 **Returns:** [*RedisStream*](redisstream.md)<T\>
 
-Defined in: [stream.ts:58](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L58)
+Defined in: [stream.ts:64](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L64)
 
 ## Properties
 
 ### ackOnIterate
 
 • **ackOnIterate**: *boolean*= false
 
-Defined in: [stream.ts:37](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L37)
+Defined in: [stream.ts:38](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L38)
 
 ___
 
 ### block
 
 • `Optional` **block**: *undefined* \| *number*
 
-Defined in: [stream.ts:34](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L34)
+Defined in: [stream.ts:34](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L34)
+
+___
+
+### buffers
+
+• `Optional` **buffers**: *undefined* \| *boolean*= false
+
+Defined in: [stream.ts:35](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L35)
 
 ___
 
 ### client
 
 • `Readonly` **client**: *Redis*
 
-Defined in: [stream.ts:26](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L26)
+Defined in: [stream.ts:26](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L26)
 
 ___
 
 ### consumer
 
 • `Optional` `Readonly` **consumer**: *undefined* \| *string*
 
-Defined in: [stream.ts:28](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L28)
+Defined in: [stream.ts:28](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L28)
 
 ___
 
 ### count
 
 • **count**: *number*= 100
 
-Defined in: [stream.ts:32](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L32)
-
-___
-
-### createdConnection
-
-• `Private` **createdConnection**: *boolean*= true
-
-Did we create the redis connection?
-
-Defined in: [stream.ts:58](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L58)
+Defined in: [stream.ts:32](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L32)
 
 ___
 
 ### deleteOnAck
 
 • **deleteOnAck**: *boolean*= false
 
-Defined in: [stream.ts:38](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L38)
+Defined in: [stream.ts:39](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L39)
 
 ___
 
@@ -131,25 +129,23 @@ ___
 
 Flag for iterable state
 
-Defined in: [stream.ts:50](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L50)
+Defined in: [stream.ts:51](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L51)
 
 ___
 
 ### first
 
 • **first**: *boolean*= false
 
-Flag for first iteration
-
-Defined in: [stream.ts:54](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L54)
+Defined in: [stream.ts:52](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L52)
 
 ___
 
 ### group
 
 • `Optional` `Readonly` **group**: *undefined* \| *string*
 
-Defined in: [stream.ts:27](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L27)
+Defined in: [stream.ts:27](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L27)
 
 ___
 
@@ -161,15 +157,15 @@ ___
 'stream' mode will dispense each stream containing entries
 'batch' mode will dispense all streams with all entries
 
-Defined in: [stream.ts:25](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L25)
+Defined in: [stream.ts:25](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L25)
 
 ___
 
 ### noack
 
 • **noack**: *boolean*= false
 
-Defined in: [stream.ts:33](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L33)
+Defined in: [stream.ts:33](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L33)
 
 ___
 
@@ -181,15 +177,15 @@ Acks waiting to be sent on either:
 - timeout
 - async iteration
 
-Defined in: [stream.ts:46](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L46)
+Defined in: [stream.ts:47](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L47)
 
 ___
 
 ### streams
 
 • **streams**: *Map*<*string*, *string*\>
 
-Defined in: [stream.ts:31](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L31)
+Defined in: [stream.ts:31](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L31)
 
 ## Methods
 
@@ -199,7 +195,7 @@ Defined in: [stream.ts:31](https://github.com/calebboyd/pez/blob/557aceb/src/str
 
 **Returns:** *AsyncIterator*<T *extends* *entry* ? XEntryResult : T *extends* *batch* ? XStreamResult[] : XStreamResult, *any*, *undefined*\>
 
-Defined in: [stream.ts:117](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L117)
+Defined in: [stream.ts:127](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L127)
 
 ___
 
@@ -216,7 +212,7 @@ Name | Type |
 
 **Returns:** *void*
 
-Defined in: [stream.ts:142](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L142)
+Defined in: [stream.ts:182](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L182)
 
 ___
 
@@ -226,14 +222,14 @@ ___
 
 **Returns:** *Promise*<*void*\>
 
-Defined in: [stream.ts:131](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L131)
+Defined in: [stream.ts:171](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L171)
 
 ___
 
 ### return
 
-▸ `Protected`**return**(): *Promise*<*IteratorReturnResult*<*void*\>\>
+▸ `Protected`**return**(): *Promise*<*void*\>
 
-**Returns:** *Promise*<*IteratorReturnResult*<*void*\>\>
+**Returns:** *Promise*<*void*\>
 
-Defined in: [stream.ts:151](https://github.com/calebboyd/pez/blob/557aceb/src/stream.ts#L151)
+Defined in: [stream.ts:191](https://github.com/calebboyd/pez/blob/91a6433/src/stream.ts#L191)

docs/interfaces/redisstreamoptions.md

@@ -18,6 +18,7 @@ Name | Type |
 
 * [ackOnIterate](redisstreamoptions.md#ackoniterate)
 * [block](redisstreamoptions.md#block)
+* [buffers](redisstreamoptions.md#buffers)
 * [consumer](redisstreamoptions.md#consumer)
 * [count](redisstreamoptions.md#count)
 * [deleteOnAck](redisstreamoptions.md#deleteonack)
@@ -40,7 +41,7 @@ automatically queue acknowledgments for previously iterated entries.
 
 **`default`** undefined
 
-Defined in: [types.ts:87](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L87)
+Defined in: [types.ts:98](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L98)
 
 ___
 
@@ -51,7 +52,18 @@ ___
 The longest amount of time in milliseconds the dispenser should block
 while waiting for new entries on any stream, passed to xread or xreadgroup
 
-Defined in: [types.ts:81](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L81)
+Defined in: [types.ts:92](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L92)
+
+___
+
+### buffers
+
+• `Optional` **buffers**: *undefined* \| *true*
+
+Return buffers with each xread operation
+This applies to entry id and kv results
+
+Defined in: [types.ts:81](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L81)
 
 ___
 
@@ -62,7 +74,7 @@ ___
 The consumer.
 Note: if only consumer is provided, a group is created automatically
 
-Defined in: [types.ts:65](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L65)
+Defined in: [types.ts:71](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L71)
 
 ___
 
@@ -75,7 +87,7 @@ eg. the "highWaterMark"
 
 **`default`** 100
 
-Defined in: [types.ts:76](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L76)
+Defined in: [types.ts:87](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L87)
 
 ___
 
@@ -88,7 +100,7 @@ automatically delete entries after acknowledgment
 
 **`default`** undefined
 
-Defined in: [types.ts:93](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L93)
+Defined in: [types.ts:104](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L104)
 
 ___
 
@@ -110,7 +122,7 @@ TODO: not yet implemented
 
 **`default`** 100
 
-Defined in: [types.ts:113](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L113)
+Defined in: [types.ts:124](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L124)
 
 ___
 
@@ -123,7 +135,7 @@ This counter is reset after each iteration or ack
 
 TODO: not yet implemented
 
-Defined in: [types.ts:120](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L120)
+Defined in: [types.ts:131](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L131)
 
 ___
 
@@ -134,7 +146,7 @@ ___
 The consumer group.
 Note: if only a group is provided a consumer is created automatically
 
-Defined in: [types.ts:60](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L60)
+Defined in: [types.ts:66](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L66)
 
 ___
 
@@ -150,7 +162,7 @@ ___
 
 **`default`** `'entry'`
 
-Defined in: [types.ts:51](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L51)
+Defined in: [types.ts:57](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L57)
 
 ___
 
@@ -162,7 +174,7 @@ Pass the NOACK flag to calls to xreadgroup bypassing the Redis PEL
 
 **`default`** `false`
 
-Defined in: [types.ts:98](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L98)
+Defined in: [types.ts:109](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L109)
 
 ___
 
@@ -173,7 +185,7 @@ ___
 The IORedis client connection.
 NOTE: by default this connection becomes a "reader" when block > 0
 
-Defined in: [types.ts:70](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L70)
+Defined in: [types.ts:76](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L76)
 
 ___
 
@@ -183,4 +195,4 @@ ___
 
 Redis stream keys to be read. If a Record is provided each value is the starting id for that stream
 
-Defined in: [types.ts:55](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L55)
+Defined in: [types.ts:61](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L61)

docs/modules.md

@@ -40,4 +40,4 @@ Renames and exports: [RedisStream](classes/redisstream.md)
 
 **`default`** `'entry'`
 
-Defined in: [types.ts:29](https://github.com/calebboyd/pez/blob/557aceb/src/types.ts#L29)
+Defined in: [types.ts:35](https://github.com/calebboyd/pez/blob/91a6433/src/types.ts#L35)