createClient({
url: "redis://alice:foobared@awesome.redis.server:6380",
});
You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in -the client configuration guide.
+the client configuration guide.To check if the the client is connected and ready to send commands, use client.isReady which returns a boolean.
client.isOpen is also available. This returns true when the client's underlying socket is open, and false when it
isn't (for example when the client is still connecting or reconnecting after a network error).
In v5 we've extracted this pool logic into its own class—RedisClientPool:
const pool = await createClientPool()
.on("error", (err) => console.error(err))
.connect();
await pool.ping();
Pub/Sub
See the Pub/Sub overview.
+Pub/Sub
See the Pub/Sub overview.
Scan Iterator
SCAN results can be looped over
using async iterators:
for await (const key of client.scanIterator()) {
// use the key!
await client.get(key);
}
@@ -123,7 +123,7 @@ of sending a QUIT command to the server, the client can simply clos
Client Side Caching
Node Redis v5 adds support for Client Side Caching, which enables clients to cache query results locally. The Redis server will notify the client when cached results are no longer valid.
// Enable client side caching with RESP3
const client = createClient({
RESP: 3,
clientSideCache: {
ttl: 0, // Time-to-live (0 = no expiration)
maxEntries: 0, // Maximum entries (0 = unlimited)
evictPolicy: "LRU" // Eviction policy: "LRU" or "FIFO"
}
});
-See the V5 documentation for more details and advanced usage.
+See the V5 documentation for more details and advanced usage.
Auto-Pipelining
Node Redis will automatically pipeline requests that are made during the same "tick".
client.set("Tm9kZSBSZWRpcw==", "users:1");
client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw==");
@@ -132,8 +132,8 @@ get await Promise.all([
client.set("Tm9kZSBSZWRpcw==", "users:1"),
client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw=="),
]);
Programmability
See the Programmability overview.
-Clustering
Check out the Clustering Guide when using Node Redis to connect to a Redis Cluster.
+Programmability
See the Programmability overview.
+Clustering
Check out the Clustering Guide when using Node Redis to connect to a Redis Cluster.
Events
The Node Redis client class is an Nodejs EventEmitter and it emits an event each time the network status changes:
sharded-channel-moved |
-See here | -See here | +See here | +See here |
@@ -179,7 +179,7 @@ advantage of auto-pipelining and handle your Promises, usePromise.all()erroroccurs, that error will be thrown and the Node.js process will exit. See the >EventEmitterdocs for more details.
-The client will not emit any other events beyond those listed above.
+The client will not emit any other events beyond those listed above.
Supported Redis versions
Node Redis is supported with the following versions of Redis: