npmpackage.info

Gathering detailed insights and metrics for ioredis-mock

Other packages similar to ioredis-mock

@types/ioredis-mock

8.2.6

TypeScript definitions for ioredis-mock

rcc-ioredis-mock-adapter

1.0.12

Wraps and adapts the 'ioredis-mock' module & its Redis client instances to be used with the 'redis-client-cache' module

@quirrel/ioredis-mock

5.6.1

This library emulates ioredis by performing all operations in-memory.

@kess-flow/ioredis-mock

5.2.7

This library emulates ioredis by performing all operations in-memory.

Gathering detailed insights and metrics for ioredis-mock

ioredis-mock - 8.9.0 | npmpackage.info

ioredis-mock

Emulates ioredis by performing all operations in-memory.

8.9.0

360

MIT

JavaScript

6.65 MB

3.9

Installations

npm install ioredis-mock

Developer Guide

BETA

Typescript

No

Module System

CommonJS, UMD

Min. Node Version

>=12.22

Node Version

18.18.0

NPM Version

9.6.7 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

8.9.0

Package Id

ioredis-mock@8.9.0

Unpacked Size

6.65 MB

Size

1.46 MB

File Count

NPM Version

9.6.7

Node Version

18.18.0

Published on

Sep 29, 2023

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 Renovatebot 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 with RunKit)

1const Redis = require('ioredis-mock')
2const 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

Browser usage (Experimental)

There's a browser build available. You can import it directly (import Redis from 'ioredis-mock/browser.js'), or use it on unpkg.com:

1import Redis from 'https://unpkg.com/ioredis-mock'
2
3const redis = new Redis()
4redis.set('foo', 'bar')
5console.log(await redis.get('foo'))

Breaking Changes

from v7 to v8

`ioredis@v4` support dropped

ioredis@v5 is the new baseline. Stay on ioredis-mock@v7 until you're ready to upgrade to ioredis@v5.

`PromiseContainer` has been removed.

Support for third-party Promise libraries is dropped. The native Promise library will always be used.

from v6 to v7

`createConnectedClient` is removed

Replace it with .duplicate() or use another new Redis instance.

Dropped support for Node v10

It's been EOL since Apr, 2021 and it's recommended to upgrade to v14.x LTS.

`ioredis-mock/jest.js` is removed

ioredis-mock is no longer doing a import { Command } from 'ioredis' internally, it's now doing a direct import import Command from 'ioredis/built/command' and thus the jest.js workaround is no longer needed:

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

from v5 to v6

Before v6, each instance of ioredis-mock lived in isolation:

1const Redis = require('ioredis-mock')
2const redis1 = new Redis()
3const redis2 = new Redis()
4
5await redis1.set('foo', 'bar')
6console.log(await redis1.get('foo'), await redis2.get('foo')) // 'bar', null

In v6 the internals were rewritten to behave more like real life redis, if the host and port is the same, the context is now shared:

1const Redis = require('ioredis-mock')
2const redis1 = new Redis()
3const redis2 = new Redis()
4const redis3 = new Redis(6380) // 6379 is the default port
5
6await redis1.set('foo', 'bar')
7console.log(
8  await redis1.get('foo'), // 'bar'
9  await redis2.get('foo'), // 'bar'
10  await redis3.get('foo') // null
11)

And since ioredis-mock now persist data between instances, you'll likely need to run flushall between testing suites:

1const Redis = require('ioredis-mock')
2
3afterEach(done => {
4  new Redis().flushall().then(() => done())
5})

Pub/Sub channels

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

1const Redis = require('ioredis-mock')
2const redisPub = new Redis()
3const redisSub = new Redis()
4
5redisSub.on('message', (channel, message) => {
6  console.log(`Received ${message} from ${channel}`)
7})
8redisSub.subscribe('emails')
9redisPub.publish('emails', 'clark@daily.planet')

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:

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

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

1const 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

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

Roadmap

You can check the roadmap project page, and the compat table, to see how close we are to feature parity with ioredis.

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

Other packages similar to ioredis-mock

Other packages similar to ioredis-mock

ioredis-mock

Installations

Developer Guide

No

CommonJS, UMD

>=12.22

18.18.0

9.6.7

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 with RunKit)

Browser usage (Experimental)

Breaking Changes

from v7 to v8

ioredis@v4 support dropped

PromiseContainer has been removed.

from v6 to v7

createConnectedClient is removed

Dropped support for Node v10

ioredis-mock/jest.js is removed

from v5 to v6

Pub/Sub channels

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

`ioredis@v4` support dropped

`PromiseContainer` has been removed.

`createConnectedClient` is removed

`ioredis-mock/jest.js` is removed