Skip to content

Commit 01e6821

Browse files
committed
wip
1 parent 6a0b4db commit 01e6821

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

docs/v4-to-v5.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To override just a specific option, use the following functions:
3939

4040
## Quit VS Disconnect
4141

42-
The `QUIT` command has been deprecated in Redis 7.2 and should now also be considered deprecated in Node-Redis. Instead of sending a `QUIT` command to the server, the client can simply close the network connection.
42+
The `QUIT` command has been deprecated in Redis 7.2 and should now also be considered deprecated in Node-Redis. Instead of sending a `QUIT` command to the server, the client can simply close the network connection.
4343

4444
Rather than using `client.quit()`, your code should use `client.close()` or `client.disconnect()`.
4545

@@ -48,17 +48,31 @@ TODO difference between `close` and `disconnect`...
4848
## Scan Iterators
4949

5050
TODO
51+
Yields chunks instead of individual items. Allows multi key operations.
52+
See the [Scan Iterators guide](./scan-iterators.md).
5153

52-
Yields chunks instead of individual items:
54+
## Legacy Mode
55+
56+
TODO
5357

5458
```javascript
55-
for await (const chunk of client.scanIterator()) {
56-
// `chunk` type is `Array<string>`
57-
// will allow multi keys operations
58-
await client.del(chunk);
59-
}
59+
const client = createClient(),
60+
legacyClient = client.legacy();
61+
62+
// use `client` for the new API
63+
await client.set('key', 'value');
64+
65+
// use `legacyClient` for the "legacy" callback API
66+
legacyClient.set('key', 'value', (err, reply) => {
67+
// ...
68+
});
6069
```
6170

71+
## Isolation Pool
72+
73+
TODO
74+
The `isolationPool` has been moved to it's on class `ClientPool`. You can create pool from a client using `client.createPool()`.
75+
6276
## Commands
6377

6478
Some command arguments/replies have changed to align more closely to data types returned by Redis:
@@ -85,6 +99,10 @@ Some command arguments/replies have changed to align more closely to data types
8599
- `SCRIPT EXISTS`: `Array<boolean>` -> `Array<number>` [^boolean-to-number]
86100
- `SISMEMBER`: `boolean` -> `number` [^boolean-to-number]
87101
- `SMISMEMBER`: `Array<boolean>` -> `Array<number>` [^boolean-to-number]
102+
- `TS.ADD`: `boolean` -> `number` [^boolean-to-number]
103+
- `GEOSEARCH_WITH`/`GEORADIUS_WITH`: `GeoReplyWith` -> `GEO_REPLY_WITH` [^enum-to-constants]
104+
- `GEORADIUSSTORE` -> `GEORADIUS_STORE`
105+
- `GEORADIUSBYMEMBERSTORE` -> `GEORADIUSBYMEMBER_STORE`
88106

89107
[^enum-to-constants]: TODO
90108

0 commit comments

Comments
 (0)