Skip to content

Commit edf78b2

Browse files
committed
docs: update readme example for default export
1 parent e0f9217 commit edf78b2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,18 @@ Requires Redis 5 or greater.
66
## Getting Started
77

88
```javascript
9-
import { RedisStream } from 'redis-x-stream'
9+
import streamEntries from 'redis-x-stream'
1010

11-
for await (const [stream, [id, keyvals]] of new RedisStream('myStream')) {
11+
for await (const [stream, [id, keyvals]] of streamEntries('myStream')) {
1212
//process an entry
1313
}
1414
```
1515
## Usage
1616

1717
See [API Docs](docs/classes/redisstream.md#constructor)
18+
19+
20+
1821
## Not yet implemented
1922
- batch mode
2023
- stream mode

0 commit comments

Comments
 (0)