npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jest-create-mock-instance

v2.0.0

Published

Create class mock instances easily with Jest

Downloads

138,743

Readme

Description

This library uses jest-mock internal package to automatically create & instantiate mock for given class/function constructor.

I've been always fan of using sinon.createStubInstance() in my tests. Unfortunately, Jest doesn't expose similar API to create new mocked instance for given class constructor. Using jest.fn() or jest's module mocks is not very convienment for various cases, take an example of these classes and unit test:

food.js

export class Food {
    consume() {}
}

cat.js

export class Cat {
    constructor(food) {
        this.food = food;
    }
    eat() {
        this.food.consume();
    }
}

and test:

cat.spec.js

import { Food } from "../food";
import { Cat } from "../cat";

let cat;
let food;
beforeEach(() => {
    food = new Food();
    cat = new Cat(food);
});

it("Must eat", () => {
    cat.eat();
    expect(food.consume).toBeCalled();
});

By using jest module mocks you must mock your module before and instantiate Food directly:

jest.mock("../food");
import { Food } from "../food";

beforeEach(() => {
    food = new Food();
})

This is very ugly when have many modules to mock (and you don't want automock by default) and when using typescript:

jest.mock("../food1");
jest.mock("../food2");
jest.mock("../food3");
import { Food1 } from "../food1";
import { Food2 } from "../food2";
import { Food3 } from "../food3";

let food1: jest.Mocked<Food1>;
let food2: jest.Mocked<Food2>;
let food3: jest.Mocked<Food3>;
beforeEach(() => {
    // Food constructors may have other required parameters so often necessary cast them to any
    food1 = new (Food1 as any)() as any;
    food2 = new (Food2 as any)() as any;
    food3 = new (Food3 as any)() as any;
});

Instead you can just write:

import createMockInstance from "jest-create-mock-instance";
import { Food } from "../food";

let food: jest.Mocked<Food>;
beforeEach(() => {
    food = createMockInstance(Food);
});

Install

npm install jest-create-mock-instance --save-dev

Typescript

createMockInstance returns jest.Mocked<T> object. Don't forget to install @types/jest package.