Code Monkey home page Code Monkey logo

jest-extra-utils's Introduction

jest-extra-utils

Jest utilities/patterns that can be useful in a big project

Installation

npm install --save-dev jest-extra-utils

Usage

asMock

Useful to keep static checking of parameters and return value with TypeScript.

It also throws an error if the given function wasn't mocked.

import { asMock } from "jest-extra-utils";
import { useDispatch } from "react-redux";

jest.mock("react-redux");

const useDispatchMock = asMock(useDispatch);

safe

Creates a partial object that is considered "safe" to use for tests.

If a property is not specified and it's used somewhere in the test, the access throws an error specifing where it's being used and the place where this object was instantiated.

/* file.ts */
interface MyObject {
  foo1: string;
  foo2: {
    foo3: string | number;
    foo4: number;
  };
}

export function myFunction(obj: MyObject) {
  return obj.foo2.foo3;
}
/* file.test.ts */
import { safe } from "jest-extra-utils";
import myFunction from "./file";

it("should return foo2.foo3 when value is string", () => {
  const value = "bar";
  const result = myFunction(
    safe({
      foo2: { foo3: value },
    })
  );
  expect(result).toBe(value);
});

it("should return foo2.foo3 when value is number", () => {
  const value = 123;
  const result = myFunction(
    safe({
      foo2: { foo4: value },
    })
  );
  expect(result).toBe(value);
});

jest-extra-utils's People

Contributors

tfoxy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.