ioredis 5.0.5 → 5.0.6

package/README.md

@@ -102,13 +102,13 @@ Medis starts with all the basic features you need:
 ## Install
 
 ```shell
-$ npm install ioredis
+npm install ioredis
 ```
 
 In a TypeScript project, you may want to add TypeScript declarations for Node.js:
 
 ```shell
-$ npm install --save-dev @types/node
+npm install --save-dev @types/node
 ```
 
 ## Basic Usage
@@ -312,19 +312,27 @@ listenForMessage();
 
 ## Handle Binary Data
 
-Arguments can be buffers:
+Binary data support is out of the box. Pass buffers to send binary data:
 
 ```javascript
-redis.set("foo", Buffer.from("bar"));
+redis.set("foo", Buffer.from([0x62, 0x75, 0x66]));
 ```
 
-And every command has a method that returns a Buffer (by adding a suffix of "Buffer" to the command name).
-To get a buffer instead of a utf8 string:
+Every command that returns a [bulk string](https://redis.io/docs/reference/protocol-spec/#resp-bulk-strings)
+has a variant command with a `Buffer` suffix. The variant command returns a buffer instead of a UTF-8 string:
 
 ```javascript
-redis.getBuffer("foo", (err, result) => {
-  // result is a buffer.
-});
+const result = await redis.getBuffer("foo");
+// result is `<Buffer 62 75 66>`
+```
+
+It's worth noticing that you don't need the `Buffer` suffix variant in order to **send** binary data. That means
+in most case you should just use `redis.set()` instead of `redis.setBuffer()` unless you want to get the old value
+with the `GET` parameter:
+
+```javascript
+const result = await redis.setBuffer("foo", "new value", "GET");
+// result is `<Buffer 62 75 66>` as `GET` indicates returning the old value.
 ```
 
 ## Pipelining
@@ -1388,7 +1396,7 @@ default, this option is disabled and can only be used for debugging purposes. Yo
 Start a Redis server on 127.0.0.1:6379, and then:
 
 ```shell
-$ npm test
+npm test
 ```
 
 `FLUSH ALL` will be invoked after each test, so make sure there's no valuable data in it before running tests.

package/built/Pipeline.d.ts

@@ -26,3 +26,6 @@ declare class Pipeline extends Commander<{
     addBatch(commands: any): this;
 }
 export default Pipeline;
+interface Pipeline {
+    length: number;
+}

package/built/utils/RedisCommander.d.ts

@@ -9,6 +9,7 @@ export interface ResultTypes<Result, Context> {
 export interface ChainableCommander extends RedisCommander<{
     type: "pipeline";
 }> {
+    length: number;
 }
 export declare type ClientContext = {
     type: keyof ResultTypes<unknown, unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ioredis",
-  "version": "5.0.5",
+  "version": "5.0.6",
   "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
   "main": "./built/index.js",
   "types": "./built/index.d.ts",