npmpackage.info

Gathering detailed insights and metrics for jest-sinon

Other packages similar to jest-sinon

@types/jest-sinon

1.0.5

TypeScript definitions for jest-sinon

sinon-jest-matchers

1.2.0

Jest matchers for sinon

jest-sandbox

1.1.2

Simple sinon like sandbox for jest

hamjest-sinon

2.0.3

Sinon Matcher for Hamjest

jest-sinon

Collection of assertions for using the mocking library Sinon.js with Jest

1.1.0

MIT

JavaScript

23.60 kB

2,770,858 2.7

Installations

npm install jest-sinon

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

16.16.0

NPM Version

8.11.0 Score

57.6

Supply Chain

55.2

Quality

70.9

Maintenance

100

Vulnerability

License

Pull Requests

Open

2

Total

28

Closed

19

Merged

7

Issues

Open

2

Total

4

Closed

2

Releases

v1.1.0

Published on 21 Jul 2022

v1.0.4-beta.1

Published on 25 Mar 2020

v1.0.3

Published on 17 Mar 2020

v1.0.3-beta.1

Published on 20 Feb 2020

View all 4 releases

Contributors

Unable to fetch Contributors

View all 2 contributors

Languages

JavaScript

JavaScript (100%)

Developer

djkf

Download Statistics

Total Downloads

2,770,858

Last Day

1,434

Last Week

5,917

Last Month

26,294

Last Year

477,877

GitHub Statistics

15 Stars

74 Commits

4 Forks

1 Watching

5 Branches

2 Contributors

Bundle Size

81.96 kB

Minified

23.60 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.1.0

Package Id

jest-sinon@1.1.0

Unpacked Size

50.82 kB

Size

5.54 kB

File Count

NPM Version

8.11.0

Node Version

16.16.0

Total Downloads

Cumulative downloads

Total Downloads

2,770,858

Last day

32.9%

1,434

Compared to previous day

Last week

8.9%

5,917

Compared to previous week

Last month

11%

26,294

Compared to previous month

Last year

-47.4%

477,877

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Jest-Sinon

Jest-Sinon is a collection of assertions for using the mocking library Sinon.js with Jest.

Example

1const bar = () => {};
2const foo = sinon.spy();
3
4foo(bar);
5
6// instead of:
7expect(foo.calledWith(bar)).toBeTruthy;
8
9// we can write:
10expect(foo).toHaveBeenCalledWith(bar);

The assertions: toHaveBeenCalledTimes, toThrow, toReturnWith, toHaveBeenCalled and toHaveBeenCalledWith clash with the in-built Jest mocking framework. Jest-Sinon will try and detect which type of spy is being used and use the correct assertion. You should be able to use both mocking libraries in parallel.

1const foo = sinon.spy();
2const bar = jest.fn();
3
4foo();
5bar();
6
7expect(foo).toHaveBeenCalled(); // true
8expect(bar).toHaveBeenCalled(); // true

Why?

There are a number of reasons why you might want to use Sinon.js instead of (or as well as) the in-built mocking assertions. Some of the use cases include:

Developer preference/familiarity to Sinon.js
Migrating a code base from Mocha/Chai/Sinon to Jest
To be difficult

Ultimately, it usually comes down to your own preferences and needs.

Installation

With npm:

npm install --save-dev jest-sinon

With yarn:

yarn add -D jest-sinon

Setup

Jest 24+

Add Jest-Sinon to your Jest setupFilesAfterEnv configuration.

1"jest": {
2  "setupFilesAfterEnv": ["jest-sinon"]
3}

Jest 23 or below

1"jest": {
2  "setupTestFrameworkScriptFile": "./testSetup.js"
3}

1// testSetup.js
2
3require('jest-sinon');

Usage

Jest-Sinon adds a number of assertions to help test Sinon.js Spies, Mocks and Stubs. Below is a list of currently implemented assertions.

`.toHaveBeenAlwaysCalledOn(obj)`

Also under the alias: .toBeAlwaysCalledOn()

`.toHaveBeenAlwaysCalledWith(args1, arg2, ...)`

Also under the alias: .toBeAlwaysCalledWith()

`.toHaveBeenAlwaysCalledWithExactly(args1, arg2, ...)`

Also under the alias: .toBeAlwaysCalledWithExactly()

`.toHaveBeenAlwaysCalledWithMatch(arg1, arg2, ...)`

Also under the alias: .toBeAlwaysCalledWithMatch()

`.toHaveBeenAlwaysCalledWithNew()`

Also under the alias: .toBeAlwaysCalledWithNew()

`.toHaveBeenCalled()`

Also under the alias: .toBeCalled()

`.toHaveBeenCalledAfter(anotherSpy)`

Also under the alias: .toBeCalledAfter()

`.toHaveBeenCalledBefore(anotherSpy)`

Also under the alias: .toBeCalledBefore()

`.toHaveBeenCalledImmediatelyAfter(anotherSpy)`

Also under the alias: .toBeCalledImmediatelyAfter()

`.toHaveBeenCalledImmediatelyBefore(anotherSpy)`

Also under the alias: .toBeCalledImmediatelyBefore()

`.toHaveBeenCalledOn(obj)`

Also under the alias: .toBeCalledOn()

`.toHaveBeenCalledOnce()`

Also under the alias: .toBeCalledOnce()

`.toHaveBeenCalledOnceWith(arg1, arg2, ...)`

Also under the alias: .toBeCalledOnceWith()

`.toHaveBeenCalledOnceWithExactly(arg1, arg2, ...)`

Also under the alias: .toBeCalledOnceWithExactly()

`.toHaveBeenCalledThrice()`

Also under the alias: .toBeCalledThrice()

`.toHaveBeenCalledTwice()`

Also under the alias: .toBeCalledTwice()

`.toHaveBeenCalledWith(arg1, arg2, ...)`

Also under the alias: .toBeCalledWith()

`.toHaveBeenCalledWithExactly(arg1, arg2, ...)`

Also under the alias: .toBeCalledWithExactly()

`.toHaveBeenCalledWithMatch(arg1, arg2, ...)`

Also under the alias: .toBeCalledWithMatch()

`.toHaveBeenCalledWithNew()`

Also under the alias: .toBeCalledWithNew()

`.toHaveCallCount(number)`

Also under the alias: .toHaveBeenCalledTimes() and .toBeCalledTimes()

`.toHaveReturnedWith(obj)`

Also under the alias: .toReturnWith(), .toHaveReturned() and .toReturn()

`.toHaveAlwaysReturnedWith(obj)`

Also under the alias: .toAlwaysReturnWith()

`.toHaveThrown(error?)`

Also under the alias: .toHaveThrownError(), .toThrow(), and .toThrowError()

`.toHaveAlwaysThrown(error?)`

Also under the alias: .toHaveAlwaysThrownError(), .toAlwaysThrow() and .toAlwaysThrowError()

For more information about what these do, you can visit Sinon.js.

Contributing

Pull requests for new features, bug fixes, and suggestions are welcome!

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.

3

Pinned-Dependencies

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

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

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

0

Code-Review

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

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.7

/10

Last Scanned on 2025-01-27

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 jest-sinon

jest-sinon

Installations

Developer Guide

No

CommonJS

16.16.0

8.11.0

Score

Pull Requests

2

28

19

7

Issues

2

4

2

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

djkf

Download Statistics

GitHub Statistics

Bundle Size

81.96 kB

23.60 kB

Maintainers

Package Meta Information

Total Downloads

2,770,858

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Jest-Sinon

Example

Why?

Installation

Setup

Jest 24+

Jest 23 or below

Usage

.toHaveBeenAlwaysCalledOn(obj)

.toHaveBeenAlwaysCalledWith(args1, arg2, ...)

.toHaveBeenAlwaysCalledWithExactly(args1, arg2, ...)

.toHaveBeenAlwaysCalledWithMatch(arg1, arg2, ...)

.toHaveBeenAlwaysCalledWithNew()

.toHaveBeenCalled()

.toHaveBeenCalledAfter(anotherSpy)

.toHaveBeenCalledBefore(anotherSpy)

.toHaveBeenCalledImmediatelyAfter(anotherSpy)

.toHaveBeenCalledImmediatelyBefore(anotherSpy)

.toHaveBeenCalledOn(obj)

.toHaveBeenCalledOnce()

.toHaveBeenCalledOnceWith(arg1, arg2, ...)

.toHaveBeenCalledOnceWithExactly(arg1, arg2, ...)

.toHaveBeenCalledThrice()

.toHaveBeenCalledTwice()

.toHaveBeenCalledWith(arg1, arg2, ...)

.toHaveBeenCalledWithExactly(arg1, arg2, ...)

.toHaveBeenCalledWithMatch(arg1, arg2, ...)

.toHaveBeenCalledWithNew()

.toHaveCallCount(number)

.toHaveReturnedWith(obj)

.toHaveAlwaysReturnedWith(obj)

.toHaveThrown(error?)

.toHaveAlwaysThrown(error?)

Contributing

10

10

10

3

0

0

`.toHaveBeenAlwaysCalledOn(obj)`

`.toHaveBeenAlwaysCalledWith(args1, arg2, ...)`

`.toHaveBeenAlwaysCalledWithExactly(args1, arg2, ...)`

`.toHaveBeenAlwaysCalledWithMatch(arg1, arg2, ...)`

`.toHaveBeenAlwaysCalledWithNew()`

`.toHaveBeenCalled()`

`.toHaveBeenCalledAfter(anotherSpy)`

`.toHaveBeenCalledBefore(anotherSpy)`

`.toHaveBeenCalledImmediatelyAfter(anotherSpy)`

`.toHaveBeenCalledImmediatelyBefore(anotherSpy)`

`.toHaveBeenCalledOn(obj)`

`.toHaveBeenCalledOnce()`

`.toHaveBeenCalledOnceWith(arg1, arg2, ...)`

`.toHaveBeenCalledOnceWithExactly(arg1, arg2, ...)`

`.toHaveBeenCalledThrice()`

`.toHaveBeenCalledTwice()`

`.toHaveBeenCalledWith(arg1, arg2, ...)`

`.toHaveBeenCalledWithExactly(arg1, arg2, ...)`

`.toHaveBeenCalledWithMatch(arg1, arg2, ...)`

`.toHaveBeenCalledWithNew()`

`.toHaveCallCount(number)`

`.toHaveReturnedWith(obj)`

`.toHaveAlwaysReturnedWith(obj)`

`.toHaveThrown(error?)`

`.toHaveAlwaysThrown(error?)`