jest-mock-module
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.5 • Public • Published

    Jest Mock Module

    Dependabot badge Dependencies Build Status Coverage Status NPM Version

    Extends jest to allow deep auto mocking of a module by spying on all functions and properties.

    Introduction

    Getting Started

    Install the extension using npm or yarn

    npm install -D "jest-mock-module"

    Example Usage

    // src/example.js
    module.exports = {
      testing: "123";
      nested: {
        test: () => true;
        testing: "456";
      }
    }
    import * as mock from "jest-mock-module";
    mock.extend(jest);
    
    jest.spy("src/example");
    
    const example = require("src/example");
    
    // Check module object properties
    jest.isMockProp(example, "testing"); // true
    console.log(example.testing); // 123
    
    // Respy on module object to get mockable
    jest.spyOn(example).testing.mockValueOnce("789");
    console.log(example.testing); // 789
    console.log(example.testing); // 123
    
    // Check module nested object properties
    jest.isMockMethod(example.nested.test); // true
    jest.isMockProp(example.nested, "testing"); // true

    It keeps the same structure of the module but replaces all functions and properties with jest mocks.

    • jest.createSpyFromModule is exported and can be used like jest.createMockFromModule. It is used internally by jest.spy in combination with jest.mock to provide a factory in place of Jest's automocking feature.

    References

    Keywords

    none

    Install

    npm i jest-mock-module

    DownloadsWeekly Downloads

    11

    Version

    0.1.5

    License

    Unlicense

    Unpacked Size

    13.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • iamogbz