@types/sinon-chai

What is @types/sinon-chai?

@types/sinon-chai is a TypeScript type definition package for the sinon-chai library, which provides Chai assertions for Sinon.js spies, stubs, and mocks. This package allows TypeScript developers to use sinon-chai with type safety and autocompletion in their projects.

What are @types/sinon-chai's main functionalities?

Spy Assertions

This feature allows you to assert that a spy was called once. The code sample demonstrates creating a spy on a method and then asserting that the method was called exactly once.

const sinon = require('sinon');
const chai = require('chai');
const sinonChai = require('sinon-chai');
chai.use(sinonChai);
const expect = chai.expect;

const myObj = {
  myMethod: function() {}
};

const spy = sinon.spy(myObj, 'myMethod');
myObj.myMethod();

expect(spy).to.have.been.calledOnce;

Stub Assertions

This feature allows you to assert that a stub was called and to check its return value. The code sample demonstrates creating a stub for a method, asserting that the stub was called, and verifying the return value.

const sinon = require('sinon');
const chai = require('chai');
const sinonChai = require('sinon-chai');
chai.use(sinonChai);
const expect = chai.expect;

const myObj = {
  myMethod: function() {
    return 'original';
  }
};

const stub = sinon.stub(myObj, 'myMethod').returns('stubbed');

expect(stub).to.have.been.called;
expect(myObj.myMethod()).to.equal('stubbed');

Mock Assertions

This feature allows you to create mocks and verify their expectations. The code sample demonstrates creating a mock for a method, setting an expectation, calling the method, and then verifying that the expectation was met.

const sinon = require('sinon');
const chai = require('chai');
const sinonChai = require('sinon-chai');
chai.use(sinonChai);
const expect = chai.expect;

const myObj = {
  myMethod: function() {}
};

const mock = sinon.mock(myObj);
mock.expects('myMethod').once();

myObj.myMethod();

mock.verify();

Other packages similar to @types/sinon-chai

@types/chai

@types/chai provides TypeScript type definitions for the Chai assertion library. While it does not include Sinon.js specific assertions, it is useful for general assertion needs in TypeScript projects.

@types/sinon

@types/sinon provides TypeScript type definitions for the Sinon.js library. It allows for creating spies, stubs, and mocks with type safety, but does not include Chai-specific assertions.

chai-as-promised

chai-as-promised extends Chai with assertions for promises. It is useful for testing asynchronous code and can be used alongside sinon-chai for comprehensive testing.

README

Installation

npm install --save @types/sinon-chai

Summary

This package contains type definitions for sinon-chai (https://github.com/domenic/sinon-chai).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sinon-chai/v2.

Additional Details

• Last updated: Wed, 18 Oct 2023 11:45:06 GMT
• Dependencies: @types/chai, @types/sinon

Credits

These definitions were written by Kazi Manzur Rashid.