then-redis - GitLite

KO | EN

gitlite — search

#python #react #typescript #golang #machine-learning #deep-learning #linux #nodejs #java #awesome #cli #awesome-list #security #open-source

then-redis

(★ 313)

A fast, promise-based Redis client for node.js

File Explorer

Download Latest Version (.zip)

- - .eslintrc
  - auth-test.js
  - buffers-test.js
  - connection-flag-test.js
  - db.js
  - decr-test.js
  - del-test.js
  - get-test.js
  - getset-test.js
  - hgetall-test.js
  - hmget-test.js
  - hmset-test.js
  - incr-test.js
  - info-test.js
  - keys-test.js
  - lpush-test.js
  - mget-test.js
  - monitor-test.js
  - mset-test.js
  - msetnx-test.js
  - quit-test.js
  - ready-flag-test.js
  - rpush-test.js
  - sadd-test.js
  - scard-test.js
  - sdiff-test.js
  - select-test.js
  - set-test.js
  - sismember-test.js
  - subscribe-test.js
  - sunion-test.js
  - transactions-test.js
  - unsubscribe-test.js
- Client.js
- index.js
- RedisUtils.js
- release.js
.eslintrc
.gitignore
.travis.yml
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/mjackson/then-redis

Downloads the entire project code from GitHub to your computer.

cd then-redis

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install --save redis redis-commands then-redis

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## This package is no longer maintained. [node_redis](https://github.com/NodeRedis/node_redis) now includes support for promises in core, so this is no longer needed.

# then-redis [![Travis][build-badge]][build] [![npm package][npm-badge]][npm]

[build-badge]: https://img.shields.io/travis/mjackson/then-redis.svg?style=flat-square
[build]: https://travis-ci.org/mjackson/then-redis

[npm-badge]: https://img.shields.io/npm/v/then-redis.svg?style=flat-square
[npm]: https://www.npmjs.org/package/then-redis

[then-redis](https://github.com/mjackson/then-redis) is a fast, promise-based [Redis](http://redis.io) client for [node.js](http://nodejs.org). It's build on top of [node_redis](https://github.com/NodeRedis/node_redis), so it's safe and stable.

## Installation

Using [npm](https://www.npmjs.com/):

$ npm install --save redis redis-commands then-redis

> Node version `>=4` is required.

Then, use as you would anything else:

```js
// using ES6 modules
import { createClient } from 'then-redis'

// using CommonJS modules
var createClient = require('then-redis').createClient
```

## Usage

To create a client:

```js
import { createClient } from 'then-redis'

// Use the default config
const db = createClient()

// Or, specify custom config with a URL
const db = createClient('tcp://localhost:6379')

// Or, use an object config
const db = createClient({
  host: 'localhost',
  port: 6379,
  password: 'password'
})
```

Once you have a client, you're ready to issue some commands. All [Redis commands](http://redis.io/commands) are present on the `Client` prototype and may be called with variable length argument lists*. Every command returns a promise for its result. [Pipelining](http://redis.io/topics/pipelining) happens automatically in most normal usage.

```js
// Simple set, incrby, and get
db.set('my-key', 1)
db.incrby('my-key', 5)
db.get('my-key').then(function (value) {
  assert.strictEqual(value, 6)
})

// Multi-key set/get
db.mset({ a: 'one', b: 'two' })
db.mget('a', 'b').then(function (values) {
  assert.deepEqual(values, [ 'one', 'two' ])
})

// Sets
db.sadd('my-set', 1, 2, 3)
db.sismember('my-set', 2).then(function (value) {
  assert.strictEqual(value, 1)
})

// Hashes
var originalHash = { a: 'one', b: 'two' }
db.hmset('my-hash', originalHash)
db.hgetall('my-hash').then(function (hash) {
  assert.deepEqual(hash, originalHash)
})

// Transactions
db.multi()
db.incr('first-key')
db.incr('second-key')
db.exec().then(function (reply) {
  assert.deepEqual(reply, [ 1, 1 ])
})

// Pubsub
var subscriber = redis.createClient()
subscriber.on('message', function (channel, message) {
  console.log('Received message: ' + message)
})
subscriber.subscribe('my-channel').then(function () {
  db.publish('my-channel', 'a message')
})
```

If you don't like the variable-length argument lists, or you already have an array of arguments that you need to pass to a command, you can always call `client.send()` directly. It takes two arguments: 1) the name of the Redis command and 2) an array of command arguments.

```js
db.send('get', [ 'my-key' ])
db.send('incrby', [ 'my-key', 5 ])
db.send('mset', [ 'a', 'one', 'b', 'two' ])
```

\* `INFO`, `MGET`, `MSET`, `MSETNX`, `HMSET`, `HGETALL`, `LPUSH`, and `RPUSH` optionally accept/return JavaScript objects for convenience in dealing with Redis' multi-key and hash APIs

## Compatibility

For best results, it is recommended that you use Redis 2.6 or above.