https://github.com/lagden/connect-redis
https://github.com/lagden/connect-redis
connect ioredis nodejs redis
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lagden/connect-redis
- Owner: lagden
- License: mit
- Created: 2020-12-17T05:25:47.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-08T19:48:35.000Z (about 1 year ago)
- Last Synced: 2025-08-08T22:54:31.488Z (2 months ago)
- Topics: connect, ioredis, nodejs, redis
- Language: JavaScript
- Homepage:
- Size: 355 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# connect-redis
[![NPM version][npm-img]][npm]
[![Node.js CI][ci-img]][ci]
[![Coverage Status][coveralls-img]][coveralls]
[![Snyk badge][snyk-img]][snyk]
[npm-img]: https://img.shields.io/npm/v/@tadashi/connect-redis.svg
[npm]: https://www.npmjs.com/package/@tadashi/connect-redis
[ci-img]: https://github.com/lagden/connect-redis/workflows/Node.js%20CI/badge.svg
[ci]: https://github.com/lagden/connect-redis/actions?query=workflow%3A%22Node.js+CI%22
[coveralls-img]: https://coveralls.io/repos/github/lagden/connect-redis/badge.svg?branch=main
[coveralls]: https://coveralls.io/github/lagden/connect-redis?branch=main
[snyk-img]: https://snyk.io/test/github/lagden/connect-redis/badge.svg
[snyk]: https://snyk.io/test/github/lagden/connect-redis
Simplifying Redis connection
## Install
```
$ npm i -S @tadashi/connect-redis
```
## Environment variable
| variable | type | required | default | description |
| -------- | -------- | -------- | ------- | -------------------- |
| REDIS | string | no | - | The address or addresses of the Redis server(s). |
| REDIS_PWD | string | no | - | The password for authenticating with the Redis server, if required. |
## API
There are two ways to connect:
### connect(\[opts\])
Connects to a Redis server or cluster.
### singleton(\[opts\])
Connects to a Redis instance or cluster as a singleton.
| parameter | type | required | default | description |
| --------- | ----------- | -------- | ------------------ | ----------------- |
| opts | Object | no | [see below](#opts) | [See configuration options](https://redis.github.io/ioredis/interfaces/CommonRedisOptions.html) |
#### opts
| parameter | type | required | default | description |
| -------------- | ---------------- | -------- | -------------- | --------------------------------------- |
| address | String\|String[] | no | 127.0.0.1:6379 | The address or addresses of the Redis server(s). |
| password | String | no | - | The password for authenticating with the Redis server, if required. |
| clusterOptions | Object | no | - | [See configuration options](https://redis.github.io/ioredis/interfaces/ClusterOptions.html) |
### Cluster
To use `Cluster`, set addresses separated by commas or an array and set [clusterOptions](https://redis.github.io/ioredis/interfaces/ClusterOptions.html).
```js
import {connect} from '@tadashi/connect-redis'
const redis = connect({
address: '127.0.0.1:6379, 127.0.0.1:6380, 127.0.0.1:6381',
// or
address: ['127.0.0.1:6379', '127.0.0.1:6380', '127.0.0.1:6381'],
// and
clusterOptions: {
retryDelayOnClusterDown: 500,
// ...
}
})
```
## Usage
```js
import {connect} from '@tadashi/connect-redis'
const redis = connect()
await redis.set('a', 'xxx')
const result = await redis.get('a')
console.log(result) // => xxx
```
---
> [!IMPORTANT]
> Buy me a coffee!
> BTC: `bc1q7famhuj5f25n6qvlm3sssnymk2qpxrfwpyq7g4`
## License
MIT © [Thiago Lagden](https://github.com/lagden)