Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NodeRedis/node-redis
Redis Node.js client
https://github.com/NodeRedis/node-redis
node-redis nodejs redis redis-client redis-cluster
Last synced: about 1 month ago
JSON representation
Redis Node.js client
- Host: GitHub
- URL: https://github.com/NodeRedis/node-redis
- Owner: redis
- License: mit
- Created: 2010-09-14T02:05:09.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T14:48:36.000Z (about 2 months ago)
- Last Synced: 2024-10-25T05:07:59.517Z (about 2 months ago)
- Topics: node-redis, nodejs, redis, redis-client, redis-cluster
- Language: TypeScript
- Homepage: https://redis.js.org/
- Size: 115 MB
- Stars: 16,908
- Watchers: 295
- Forks: 1,885
- Open Issues: 346
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-star-libs - NodeRedis / node-redis
README
# Node-Redis
[](https://github.com/redis/node-redis/actions/workflows/tests.yml)
[](https://codecov.io/gh/redis/node-redis)
[](https://github.com/redis/node-redis/blob/master/LICENSE)
[](https://discord.gg/redis)
[](https://www.twitch.tv/redisinc)
[](https://www.youtube.com/redisinc)
[](https://twitter.com/redisinc)
node-redis is a modern, high performance [Redis](https://redis.io) client for Node.js.
## How do I Redis?
[Learn for free at Redis University](https://university.redis.com/)
[Build faster with the Redis Launchpad](https://launchpad.redis.com/)
[Try the Redis Cloud](https://redis.com/try-free/)
[Dive in developer tutorials](https://developer.redis.com/)
[Join the Redis community](https://redis.com/community/)
[Work at Redis](https://redis.com/company/careers/jobs/)
## Installation
Start a redis-server via docker (or any other method you prefer):
```bash
docker run -p 6379:6379 -it redis/redis-stack-server:latest
```
To install node-redis, simply:
```bash
npm install redis
```
> "redis" is the "whole in one" package that includes all the other packages. If you only need a subset of the commands, you can install the individual packages. See the list below.
## Packages
| Name | Description |
|------------------------------------------------|---------------------------------------------------------------------------------------------|
| [`redis`](./packages/redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
| [`@redis/client`](./packages/client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
| [`@redis/bloom`](./packages/bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
| [`@redis/graph`](./packages/graph) | [Redis Graph](https://redis.io/docs/data-types/probabilistic/) commands |
| [`@redis/json`](./packages/json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
| [`@redis/search`](./packages/search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
| [`@redis/time-series`](./packages/time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
> Looking for a high-level library to handle object mapping? See [redis-om-node](https://github.com/redis/redis-om-node)!
## Contributing
If you'd like to contribute, check out the [contributing guide](CONTRIBUTING.md).
Thank you to all the people who already contributed to Node Redis!
[](https://github.com/redis/node-redis/graphs/contributors)
## License
This repository is licensed under the "MIT" license. See [LICENSE](LICENSE).