npmpackage.info

Gathering detailed insights and metrics for @quirrel/ioredis-mock

@quirrel/ioredis-mock - 5.6.1 | npmpackage.info

@quirrel/ioredis-mock

Emulates ioredis by performing all operations in-memory.

5.6.1

360

MIT

JavaScript

509.39 kB

3.9

Installations

npm install @quirrel/ioredis-mock

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Pull Requests

Open

18

Total

1,153

Closed

142

Merged

993

Issues

Open

70

Total

207

Closed

137

Releases

189

v8.9.0

Updated on Sep 29, 2023

v7.5.1

Updated on Sep 29, 2023

v8.8.3

Updated on Aug 15, 2023

v7.5.0

Updated on Aug 15, 2023

v8.8.2

Updated on Aug 13, 2023

v8.8.1

Updated on Jul 14, 2023

View All 189 releases

Languages

JavaScript

JavaScript (100%)

Developer

stipsan

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

360 Stars

1,286 Commits

131 Forks

4 Watchers

12 Branches

90 Contributors

Updated on Jun 28, 2025

Maintainers

View All 90 Contributors

Package Meta Information

Latest Version

5.6.1

Package Id

@quirrel/ioredis-mock@5.6.1

Unpacked Size

509.39 kB

Size

99.46 kB

File Count

167

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

ioredis-mock ·

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)

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

Configuring Jest

Use the jest specific bundle when setting up mocks:

1jest.mock('ioredis', () => require('ioredis-mock/jest'));

The ioredis-mock/jest bundle inlines imports from ioredis that ioredis-mock rely on. Thus you can map ioredis import identifiers to ioredis-mock/jest without dealing with circular issues.

Pub/Sub channels

We also support redis publish/subscribe channels (just like ioredis). Like ioredis, you need two clients:

the pubSub client for subcriptions and events, which can only be used for subscriptions
the usual client for issuing 'synchronous' commands like get, publish, etc

1var Redis = require('ioredis-mock');
2var redisPubSub = new Redis();
3// create a second Redis Mock (connected to redisPubSub)
4var redisSync = redisPubSub.createConnectedClient();
5redisPubSub.on('message', (channel, message) => {
6  expect(channel).toBe('emails');
7  expect(message).toBe('clark@daily.planet');
8  done();
9});
10redisPubSub.subscribe('emails');
11redisSync.publish('emails', 'clark@daily.planet');

Promises

By default, ioredis-mock uses the native Promise library. If you need (or prefer) bluebird promises, set Redis.Promise:

1var Promise = require('bluebird');
2var Redis = require('ioredis-mock');
3
4Redis.Promise = Promise;

Lua scripting

You can use the defineCommand to define custom commands using lua or eval to directly execute lua code.

In order to create custom commands, using lua scripting, ioredis exposes the defineCommand method.

You could define a custom command MULTIPLY which accepts one key and one argument. A redis key, where you can get the multiplicand, and an argument which will be the multiplicator:

1var Redis = require('ioredis-mock');
2const redis = new Redis({ data: { 'k1': 5 } });
3const commandDefinition: { numberOfKeys: 1, lua: 'return KEYS[1] * ARGV[1]' };
4redis.defineCommand('MULTIPLY', commandDefinition) // defineCommand(name, definition)
5  // now we can call our brand new multiply command as an ordinary command
6  .then(() => redis.multiply('k1', 10));
7  .then(result => {
8    expect(result).toBe(5 * 10);
9  })

You can also achieve the same effect by using the eval command:

1var Redis = require('ioredis-mock');
2const redis = new Redis({ data: { k1: 5 } });
3const result = redis.eval(`return redis.call("GET", "k1") * 10`);
4expect(result).toBe(5 * 10);

note we are calling the ordinary redis GET command by using the global redis object's call method.

As a difference from ioredis we currently don't support:

dynamic key number by passing the number of keys as the first argument of the command.
automatic definition of the custom command buffer companion (i.e. for the custom command multiply the multiplyBuffer which returns values using Buffer.from(...))
the evalsha command
the script command

Cluster(Experimental)

Work on Cluster support has started, the current implementation is minimal and PRs welcome #359

1var Redis = require('ioredis-mock');
2
3const cluster = new Redis.Cluster(['redis://localhost:7001']);
4const nodes = cluster.nodes;
5expect(nodes.length).toEqual(1);

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! 😄

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

7

SAST

Determines if the project uses static code analysis.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 6

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:115: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:143: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:148: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coveralls.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/coveralls.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coveralls.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/coveralls.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/coveralls.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/coveralls.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/updatecompat.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/updatecompat.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/updatecompat.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/updatecompat.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/updatesnapshot.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/updatesnapshot.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/updatesnapshot.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/stipsan/ioredis-mock/updatesnapshot.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:79
Info: 0 out of 23 GitHub-owned GitHubAction dependencies pinned
Info: 3 out of 4 third-party GitHubAction dependencies pinned
Info: 8 out of 9 npmCommand dependencies pinned

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.9

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@quirrel/ioredis-mock

Installations

Developer Guide

No

CommonJS

>=10

Pull Requests

18

1,153

142

993

Issues

70

207

137

Releases

Languages

Developer

stipsan

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

ioredis-mock ·

Usage (try it in your browser)

Configuring Jest

Pub/Sub channels

Promises

Lua scripting

Cluster(Experimental)

Roadmap

I need a feature not listed here

10

10

10

10

7

6

2

0

0

0

0

0

0

0

3.9

/10