Add type definition file to the output about jest-matcher-deep-close-to HOT 6 CLOSED

Looks like the maintainers have fixed the issue in the source code, but those changes have yet to be published on NPM. Until they bump the NPM version, here's a workaround:

If you don't already have one, create a @types directory somewhere in your repository path (mine is at src/@types). Inside of this directory, create another directory called jest-matcher-deep-close-to. This directory will have a single file, index.d.ts, with the following contents (note: I have made some small modifications to the current index.d.ts):

// src/@types/jest-matcher-deep-close-to/index.d.ts

declare namespace jest {
  interface Matchers<R> {
    toBeDeepCloseTo: (expected: number | number[] | object, decimals?: number) => R;
    toMatchCloseTo: (expected: number | number[] | object, decimals?: number) => R;
  }
}

declare module 'jest-matcher-deep-close-to' {
  export function toBeDeepCloseTo(
    received: number | number[] | object,
    expected: number | number[] | object,
    decimals?: number,
  ): {
    message(): string;
    pass: boolean;
  };

  export function toMatchCloseTo(
    received: number | number[] | object,
    expected: number | number[] | object,
    decimals?: number,
  ): {
    message(): string;
    pass: boolean;
  };
}

Newer versions of TypeScript should pick up this module declaration automatically. If they don't you may need to modify your compiler options types and/or typeRoots.

@rob893 This should make it much easier to work on multiple machines/reinstall packages as you'll have your own declaration committed to source control.

from jest-matcher-deep-close-to.

I had this same issue. I just put the index.d.ts file from here into the node module, but it is annoying to do that for each computer that I work on.

from jest-matcher-deep-close-to.

The new version was done in typescript, so everything should be already natively available

from jest-matcher-deep-close-to.

error TS2339: Property 'toMatchCloseTo' does not exist on type 'JestMatchers<[string, number][]>'.

Using version 2.0.1.

from jest-matcher-deep-close-to.

I tried import 'jest-matcher-deep-close-to/src/jest.d.ts' as the jest.d.ts is present only in src and not in lib but no help Probably needs to be added somewhere in tsconfig? Uninstalling for now.

from jest-matcher-deep-close-to.

It's silly that you have to do this, but you can import just the jest augmentation using a TypeScript triple-slash directive. Put this in something like test-utils.ts:

/// <reference types="jest-matcher-deep-close-to/src/jest" />
/** Utility code for unit tests */

import {toBeDeepCloseTo} from 'jest-matcher-deep-close-to';
expect.extend({toBeDeepCloseTo});

Then import that from your tests and you should be good to go, both for types and runtime.

from jest-matcher-deep-close-to.