https://github.com/moaxaca/async-redis

First class async & promise support for redis.
https://github.com/moaxaca/async-redis

async async-redis database node-redis nodejs promise-support redis

Last synced: 3 months ago
JSON representation

First class async & promise support for redis.

• Host: GitHub
• URL: https://github.com/moaxaca/async-redis
• Owner: moaxaca
• License: other
• Created: 2017-03-24T04:20:08.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-01-06T19:53:41.000Z (over 2 years ago)
• Last Synced: 2024-10-29T23:19:23.120Z (8 months ago)
• Topics: async, async-redis, database, node-redis, nodejs, promise-support, redis
• Language: JavaScript
• Homepage:
• Size: 425 KB
• Stars: 168
• Watchers: 7
• Forks: 21
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Async Redis

===========================

[![ci](https://github.com/moaxaca/async-redis/actions/workflows/ci.yaml/badge.svg)](https://github.com/moaxaca/async-redis/actions/workflows/ci.yaml)

[![npm](https://img.shields.io/npm/v/async-redis.svg)](https://www.npmjs.com/package/async-redis)

[![npm](https://img.shields.io/npm/dm/async-redis.svg)](https://www.npmjs.com/package/async-redis)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/moaxaca/async-redis/blob/master/LICENSE)

[![Coverage Status](https://coveralls.io/repos/github/moaxaca/async-redis/badge.svg)](https://coveralls.io/github/moaxaca/async-redis)

[![Maintainability](https://api.codeclimate.com/v1/badges/141c7e0d80d10b10c42a/maintainability)](https://codeclimate.com/github/moaxaca/async-redis/maintainability)

[![Known Vulnerabilities](https://snyk.io/test/github/moaxaca/async-redis/badge.svg?targetFile=package.json)](https://snyk.io/test/github/moaxaca/async-redis?targetFile=package.json)

Light weight wrapper over the [node_redis](https://github.com/NodeRedis/node_redis) library with first class async & promise support. 

## Installation

To install the stable version:

``` 

npm install --save async-redis

```

## Usage Example

### Creating Connection

```js

const asyncRedis = require("async-redis");

const client = asyncRedis.createClient();

client.on("error", function (err) {

    console.log("Error " + err);

});

const asyncBlock = async () => {

  await client.set("string key", "string val");

  const value = await client.get("string key");

  console.log(value);

  await client.flushall("string key");

};

```

### Decorating Existing Connections

```js

const redis = require("redis");

const client = redis.createClient();

const asyncRedis = require("async-redis");

const asyncRedisClient = asyncRedis.decorate(client);

```

## API Information

This library does very little modification to the api of node_redis. 

It simply appends a promise resolving/rejecting callback for every command. 

For information on redis commands and configuration visit node_redis 

[docs](http://redis.js.org). 

## License

MIT