[](https://github.com/redis/ioredis)
[](https://github.com/redis/ioredis/actions/workflows/release.yml?query=branch%3Amain)
[](https://coveralls.io/github/luin/ioredis?branch=main)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/semantic-release/semantic-release)
[](https://discord.gg/redis)
[](https://www.twitch.tv/redisinc)
[](https://www.youtube.com/redisinc)
[](https://twitter.com/redisinc)
A robust, performance-focused and full-featured [Redis](http://redis.io) client for [Node.js](https://nodejs.org).
Supports Redis >= 2.6.12. Completely compatible with Redis 7.x.
# Features
ioredis is a robust, full-featured Redis client that is
used in the world's biggest online commerce company [Alibaba](http://www.alibaba.com/) and many other awesome companies.
0. Full-featured. It supports [Cluster](http://redis.io/topics/cluster-tutorial), [Sentinel](https://redis.io/docs/reference/sentinel-clients), [Streams](https://redis.io/topics/streams-intro), [Pipelining](http://redis.io/topics/pipelining), and of course [Lua scripting](http://redis.io/commands/eval), [Redis Functions](https://redis.io/topics/functions-intro), [Pub/Sub](http://redis.io/topics/pubsub) (with the support of binary messages).
1. High performance ð.
2. Delightful API ð. It works with Node callbacks and Native promises.
3. Transformation of command arguments and replies.
4. Transparent key prefixing.
5. Abstraction for Lua scripting, allowing you to [define custom commands](https://github.com/redis/ioredis#lua-scripting).
6. Supports [binary data](https://github.com/redis/ioredis#handle-binary-data).
7. Supports [TLS](https://github.com/redis/ioredis#tls-options) ð.
8. Supports offline queue and ready checking.
9. Supports ES6 types, such as `Map` and `Set`.
10. Supports GEO commands ð.
11. Supports Redis ACL.
12. Sophisticated error handling strategy.
13. Supports NAT mapping.
14. Supports autopipelining.
**100% written in TypeScript and official declarations are provided:**
<img width="837" src="resources/ts-screenshot.png" alt="TypeScript Screenshot" />
# Versions
| Version | Branch | Node.js Version | Redis Version |
| -------------- | ------ | --------------- | --------------- |
| 5.x.x (latest) | main | >= 12 | 2.6.12 ~ latest |
| 4.x.x | v4 | >= 6 | 2.6.12 ~ 7 |
Refer to [CHANGELOG.md](CHANGELOG.md) for features and bug fixes introduced in v5.
ð [Upgrading from v4 to v5](https://github.com/redis/ioredis/wiki/Upgrading-from-v4-to-v5)
# Links
- [API Documentation](https://redis.github.io/ioredis/) ([Redis](https://redis.github.io/ioredis/classes/Redis.html), [Cluster](https://redis.github.io/ioredis/classes/Cluster.html))
- [Changelog](CHANGELOG.md)
<hr>
# Quick Start
## Install
```shell
npm install ioredis
```
In a TypeScript project, you may want to add TypeScript declarations for Node.js:
```shell
npm install --save-dev @types/node
```
## Basic Usage
```javascript
// Import ioredis.
// You can also use `import { Redis } from "ioredis"`
// if your project is a TypeScript project,
// Note that `import Redis from "ioredis"` is still supported,
// but will be deprecated in the next major version.
const Redis = require("ioredis");
// Create a Redis instance.
// By default, it will connect to localhost:6379.
// We are going to cover how to specify connection options soon.
const redis = new Redis();
redis.set("mykey", "value"); // Returns a promise which resolves to "OK" when the command succeeds.
// ioredis supports the node.js callback style
redis.get("mykey", (err, result) => {
if (err) {
console.error(err);
} else {
console.log(result); // Prints "value"
}
});
// Or ioredis returns a promise if the last argument isn't a function
redis.get("mykey").then((result) => {
console.log(result); // Prints "value"
});
redis.zadd("sortedSet", 1, "one", 2, "dos", 4, "quatro", 3, "three");
redis.zrange("sortedSet", 0, 2, "WITHSCORES").then((elements) => {
// ["one", "1", "dos", "2", "three", "3"] as if the command was `redis> ZRANGE sortedSet 0 2 WITHSCORES`
console.log(elements);
});
// All arguments are passed directly to the redis server,
// so technically ioredis supports all Redis commands.
// The format is: redis[SOME_REDIS_COMMAND_IN_LOWERCASE](ARGUMENTS_ARE_JOINED_INTO_COMMAND_STRING)
// so the following statement is equivalent to the CLI: `redis> SET mykey hello EX 10`
redis.set("mykey", "hello", "EX", 10);
```
See the `examples/` folder for more examples. For example:
- [TTL](examples/ttl.js)
- [Strings](examples/string.js)
- [Hashes](examples/hash.js)
- [Lists](examples/list.js)
- [Sets](examples/set.js)
- [Sorted Sets](examples/zset.js)
- [Streams](examples/stream.js)
- [Redis Modules](examples/module.js) e.g. RedisJSON
All Redis commands are supported. See [the documentation](https://redis.github.io/ioredis/classes/Redis.html) for details.
## Connect to Redis
When a new `Redis` instance is created,
a connection to Redis will be created at the same time.
You can specify which Redis to connect to by:
```javascript
new Redis(); // Connect to 127.0.0.1:6379
new Redis(6380); // 127.0.0.1:6380
new Redis(6379, "192.168.1.1"); // 192.168.1.1:6379
new Redis("/tmp/redis.sock");
new Redis({
port: 6379, // Redis port
host: "127.0.0.1", // Redis host
username: "default", // needs Redis >= 6
password: "my-top-secret",
db: 0, // Defaults to 0
});
```
You can also specify connection options as a [`redis://` URL](http://www.iana.org/assignments/uri-schemes/prov/redis) or [`rediss://` URL](https://www.iana.org/assignments/uri-schemes/prov/rediss) when using [TLS encryption](#tls-options):
```javascript
// Connect to 127.0.0.1:6380, db 4, using password "authpassword":
new Redis("redis://:authpassword@127.0.0.1:6380/4");
// Username can also be passed via URI.
new Redis("redis://username:authpassword@127.0.0.1:6380/4");
```
See [API Documentation](https://redis.github.io/ioredis/index.html#RedisOptions) for all available options.
## Pub/Sub
Redis provides several commands for developers to implement the [Publishâsubscribe pattern](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern). There are two roles in this pattern: publisher and subscriber. Publishers are not programmed to send their messages to specific subscribers. Rather, published messages are characterized into channels, without knowledge of what (if any) subscribers there may be.
By leveraging Node.js's built-in events module, ioredis makes pub/sub very straightforward to use. Below is a simple example that consists of two files, one is publisher.js that publishes messages to a channel, the other is subscriber.js that listens for messages on specific channels.
```javascript
// publisher.js
const Redis = require("ioredis");
const redis = new Redis();
setInterval(() => {
const message = { foo: Math.random() };
// Publish to my-channel-1 or my-channel-2 randomly.
const channel = `my-channel-${1 + Math.round(Math.random())}`;
// Message can be either a string or a buffer
redis.publish(channel, JSON.stringify(message));
console.log("Published %s to %s", message, channel);
}, 1000);
```
```javascript
适用于 Node.js 的强大、注重性能且功能齐全的 Redis 客户端 .zip （194个子文件） 
icons.css 34KB style.css 32KB highlight.css 2KB style.css 111B Dockerfile 724B .gitignore 111B
Redis.html 5.61MB Cluster.html 5.55MB ChainableCommander.html 5.08MB CommonRedisOptions.html 54KB ClusterOptions.html 43KB SentinelConnectionOptions.html 32KB index.html 30KB SentinelAddress.html 8KB NatMap.html 5KB index.jade 233B layout.jade 125B users.jade 87B error.jade 84B search.js 306KB main.js 42KB returnTypes.js 9KB basic_operations.js 2KB stream.js 1KB custom_connector.js 1KB index.js 1KB overrides.js 1KB redis_streams.js 1KB hash.js 1KB ttl.js 1KB string.js 1KB app.js 1KB list.js 789B zset.js 785B set.js 526B sortArguments.js 510B users.js 426B typeMaps.js 408B module.js 403B index.js 274B argumentTypes.js 255B redis.js 250B package-lock.json 560KB package-lock.json 78KB package-lock.json 8KB package.json 3KB .eslintrc.json 2KB .releaserc.json 638B package.json 320B tsconfig.json 305B package.json 293B LICENSE 1KB CHANGELOG.md 80KB README.md 58KB CODE_OF_CONDUCT.md 3KB CONTRIBUTING.md 2KB README.md 369B .nojekyll 143B
medis.png 165KB redis-tryfree.png 112KB ts-screenshot.png 48KB upstash.png 36KB icons@2x.png 27KB icons.png 9KB widgets@2x.png 855B widgets.png 480B .prettierignore 54B main.sh 208B
logo.svg 4KB RedisCommander.ts 382KB index.ts 29KB Redis.ts 25KB sentinel.ts 23KB autopipelining.ts 17KB connection.ts 14KB index.ts 13KB index.ts 12KB Command.ts 12KB connect.ts 11KB pipeline.ts 11KB Pipeline.ts 11KB event_handler.ts 10KB utils.ts 10KB auth.ts 8KB TLSProfiles.ts 8KB send_command.ts 8KB scripting.ts 8KB DataHandler.ts 8KB RedisOptions.ts 7KB pipeline.ts 7KB index.ts 7KB autopipelining.ts 7KB ClusterSubscriber.ts 6KB pub_sub.ts 6KB transformer.ts 6KB scan_stream.ts 6KB transaction.ts 6KB redis.ts 6KB autoPipelining.ts 5KB ClusterOptions.ts 5KB共 194 条
- 1
- 2
资源评论
