thedeveloper/node-redis-script

Easily run redis scripts from node

redis-script

Easily run redis scripts from Node.

Requirements

• node-redis v0.10+ or ioredis
• Redis v2.6 or above
• Node 10+

Install

npm install node-redis-script

Usage

const redis = require('redis').createClient();
const { createScript } = require('node-redis-script');

const incrbyExSrc = `
  local current
  current = redis.call('incrby',KEYS[1],ARGV[1])
  redis.call('expire',KEYS[1],ARGV[2]);
  return current
`;

// give it a redis client and script source
const opts = { redis }; // or { ioredis } for ioredis
const incrbyEx = createScript(opts, incrbyExSrc);
// you get back a function that runs your script with given args
// redis requires you to tell it how many keys to expect
const numKeys = 1;
const key = 'test';
const incr = 1;
const ex = 10;
const result = await incrbyEx(numKeys, key, incr, ex);
// Should print 1
console.log(result);

Options

const opts = {
  // you can use either node-redis or ioredis client
  redis, // node-redis client
  ioredis // ioredis client
};

Test

# install docker & docker-compose for local redis setup
npm test

node-redis-script's Issues

Switch to IORedis instead of promisify

@TheDeveloper I use the excellent warlock which relies on this library (or more accurately the deprecated scripty library) and I'd like to move away from node-redis since it doesn't support promises.

I can see that this library uses promisify and I think that it should directly use IORedis instead. That way, we could easily change the warlock client as well and have a cleaner code.