Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    ioredis-mockpublic

    ioredis-mock · CircleCI Status AppVeyor branch npm npm version Redis Compatibility: 54% semantic-release

    This library emulates ioredis by performing all operations in-memory. The best way to do integration testing against redis and ioredis is on a real redis-server instance. However, there are cases where mocking the redis-server is a better option.

    Cases like:

    • Your workflow already use a local redis-server instance for the dev server.
    • You're on a platform without an official redis release, that's even worse than using an emulator.
    • You're running tests on a CI, setting it up is complicated. If you combine it with CI that also run selenium acceptance testing it's even more complicated, as two redis-server instances on the same CI build is hard.
    • The GitHub repo have bots that run the testing suite and is limited through npm package.json install scripts and can't fire up servers. (Having Greenkeeper notifying you when a new release of ioredis is out and wether your code breaks or not is awesome).

    Check the compatibility table for supported redis commands.

    Usage (try it in your browser)

    var Redis = require('ioredis-mock');
    var redis = new Redis({
      // `options.data` does not exist in `ioredis`, only `ioredis-mock`
      data: {
        user_next: '3',
        emails: {
          'clark@daily.planet': '1',
          'bruce@wayne.enterprises': '2',
        },
        'user:1': { id: '1', username: 'superman', email: 'clark@daily.planet' },
        'user:2': { id: '2', username: 'batman', email: 'bruce@wayne.enterprises' },
      },
    });
    // Basically use it just like ioredis

    Roadmap

    This project started off as just an utility in another project and got open sourced to benefit the rest of the ioredis community. This means there's work to do before it's feature complete:

    • Setup testing suite for the library itself.
    • Refactor to bluebird promises like ioredis, support node style callback too.
    • Implement remaining basic features that read/write data.
    • Implement ioredis argument and reply transformers.
    • Connection Events
    • Offline Queue
    • Pub/Sub
    • Error Handling
    • Implement remaining commands

    I need a feature not listed here

    Just create an issue and tell us all about it or submit a PR with it! :-)

    install

    npm i ioredis-mock

    Downloadslast 7 days

    4,487

    version

    3.8.1

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar