Interface Matchers<R, T>

interface Matchers<R, T = {}> {
 toEqualBindings: (actual: Bindings) => R;
 toEqualBindingsArray: (actual: Bindings[], ignoreOrder?: boolean) => R;
 toEqualBindingsStream: (
 actual: Bindings[],
 ignoreOrder?: boolean,
 ) => Promise<R>;
 toFailTest: (actual: string) => R;
 toPassTest: (actual: any) => R;
 toPassTestVoid: () => R;
 lastCalledWith<E extends any[]>(...args: E): R;
 lastReturnedWith<E = any>(expected?: E): R;
 nthCalledWith<E extends any[]>(nthCall: number, ...params: E): R;
 nthReturnedWith<E = any>(n: number, expected?: E): R;
 toBe<E = any>(expected: E): R;
 toBeCalled(): R;
 toBeCalledTimes(expected: number): R;
 toBeCalledWith<E extends any[]>(...args: E): R;
 toBeCloseTo(expected: number, numDigits?: number): R;
 toBeDefined(): R;
 toBeFalsy(): R;
 toBeGreaterThan(expected: number | bigint): R;
 toBeGreaterThanOrEqual(expected: number | bigint): R;
 toBeInstanceOf<E = any>(expected: E): R;
 toBeLessThan(expected: number | bigint): R;
 toBeLessThanOrEqual(expected: number | bigint): R;
 toBeNaN(): R;
 toBeNull(): R;
 toBeTruthy(): R;
 toBeUndefined(): R;
 toContain<E = any>(expected: E): R;
 toContainEqual<E = any>(expected: E): R;
 toEqual<E = any>(expected: E): R;
 toHaveBeenCalled(): R;
 toHaveBeenCalledTimes(expected: number): R;
 toHaveBeenCalledWith<E extends any[]>(...params: E): R;
 toHaveBeenLastCalledWith<E extends any[]>(...params: E): R;
 toHaveBeenNthCalledWith<E extends any[]>(nthCall: number, ...params: E): R;
 toHaveLastReturnedWith<E = any>(expected?: E): R;
 toHaveLength(expected: number): R;
 toHaveNthReturnedWith<E = any>(nthCall: number, expected?: E): R;
 toHaveProperty<E = any>(
 propertyPath: string | readonly any[],
 value?: E,
 ): R;
 toHaveReturned(): R;
 toHaveReturnedTimes(expected: number): R;
 toHaveReturnedWith<E = any>(expected?: E): R;
 toMatch(expected: string | RegExp): R;
 toMatchInlineSnapshot(
 propertyMatchers: Partial,
 snapshot?: string,
 ): R;
 toMatchInlineSnapshot(snapshot?: string): R;
 toMatchObject<E extends {} | any[]>(expected: E): R;
 toMatchSnapshot(
 propertyMatchers: Partial,
 snapshotName?: string,
 ): R;
 toMatchSnapshot(snapshotName?: string): R;
 toReturn(): R;
 toReturnTimes(count: number): R;
 toReturnWith<E = any>(value?: E): R;
 toStrictEqual<E = any>(expected: E): R;
 toThrow(error?: string | RegExp | Constructable | Error): R;
 toThrowError(error?: string | RegExp | Constructable | Error): R;
 toThrowErrorMatchingInlineSnapshot(snapshot?: string): R;
 toThrowErrorMatchingSnapshot(snapshotName?: string): R;
}

Type Parameters

R
T = {}

Index

Properties

toEqualBindings toEqualBindingsArray toEqualBindingsStream toFailTest toPassTest toPassTestVoid

Properties

toEqualBindings

toEqualBindings: (actual: Bindings) => R

toEqualBindingsArray

toEqualBindingsArray: (actual: Bindings[], ignoreOrder?: boolean) => R

toEqualBindingsStream

toEqualBindingsStream: (actual: Bindings[], ignoreOrder?: boolean) => Promise<R>

toFailTest

toFailTest: (actual: string) => R

toPassTest

toPassTest: (actual: any) => R

toPassTestVoid

toPassTestVoid: () => R

Methods

lastCalledWith

lastCalledWith<E extends any[]>(...args: E): R
Ensures the last call to a mock function was provided specific args.

Optionally, you can provide a type for the expected arguments via a generic. Note that the type must be either an array or a tuple.
Type Parameters
- E extends any[]
Parameters
- ...args: E
Returns R
Deprecated
in favor of toHaveBeenLastCalledWith
- Defined in node_modules/@types/jest/index.d.ts:813

lastReturnedWith

lastReturnedWith<E = any>(expected?: E): R
Ensure that the last call to a mock function has returned a specified value.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- Optionalexpected: E
Returns R
Deprecated
in favor of toHaveLastReturnedWith
- Defined in node_modules/@types/jest/index.d.ts:823

nthCalledWith

nthCalledWith<E extends any[]>(nthCall: number, ...params: E): R
Ensure that a mock function is called with specific arguments on an Nth call.

Optionally, you can provide a type for the expected arguments via a generic. Note that the type must be either an array or a tuple.
Type Parameters
- E extends any[]
Parameters
- nthCall: number
- ...params: E
Returns R
Deprecated
in favor of toHaveBeenNthCalledWith
- Defined in node_modules/@types/jest/index.d.ts:833

nthReturnedWith

nthReturnedWith<E = any>(n: number, expected?: E): R
Ensure that the nth call to a mock function has returned a specified value.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- n: number
- Optionalexpected: E
Returns R
Deprecated
in favor of toHaveNthReturnedWith
- Defined in node_modules/@types/jest/index.d.ts:843

toBe

toBe<E = any>(expected: E): R
Checks that a value is what you expect. It uses Object.is to check strict equality. Don't use toBe with floating-point numbers.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- expected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:852

toBeCalled

toBeCalled(): R
Ensures that a mock function is called.

Returns R
Deprecated
in favor of toHaveBeenCalled
- Defined in node_modules/@types/jest/index.d.ts:858

toBeCalledTimes

toBeCalledTimes(expected: number): R
Ensures that a mock function is called an exact number of times.
Parameters
- expected: number
Returns R
Deprecated
in favor of toHaveBeenCalledTimes
- Defined in node_modules/@types/jest/index.d.ts:864

toBeCalledWith

toBeCalledWith<E extends any[]>(...args: E): R
Ensure that a mock function is called with specific arguments.

Optionally, you can provide a type for the expected arguments via a generic. Note that the type must be either an array or a tuple.
Type Parameters
- E extends any[]
Parameters
- ...args: E
Returns R
Deprecated
in favor of toHaveBeenCalledWith
- Defined in node_modules/@types/jest/index.d.ts:874

toBeCloseTo

toBeCloseTo(expected: number, numDigits?: number): R
Using exact equality with floating point numbers is a bad idea. Rounding means that intuitive things fail. The default for numDigits is 2.
Parameters
- expected: number
- OptionalnumDigits: number
Returns R
- Defined in node_modules/@types/jest/index.d.ts:880

toBeDefined

toBeDefined(): R
Ensure that a variable is not undefined.

Returns R
- Defined in node_modules/@types/jest/index.d.ts:884

toBeFalsy

toBeFalsy(): R
When you don't care what a value is, you just want to ensure a value is false in a boolean context.

Returns R
- Defined in node_modules/@types/jest/index.d.ts:889

toBeGreaterThan

toBeGreaterThan(expected: number | bigint): R
For comparing floating point or big integer numbers.
Parameters
- expected: number | bigint
Returns R
- Defined in node_modules/@types/jest/index.d.ts:893

toBeGreaterThanOrEqual

toBeGreaterThanOrEqual(expected: number | bigint): R
For comparing floating point or big integer numbers.
Parameters
- expected: number | bigint
Returns R
- Defined in node_modules/@types/jest/index.d.ts:897

toBeInstanceOf

toBeInstanceOf<E = any>(expected: E): R
Ensure that an object is an instance of a class. This matcher uses instanceof underneath.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- expected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:906

toBeLessThan

toBeLessThan(expected: number | bigint): R
For comparing floating point or big integer numbers.
Parameters
- expected: number | bigint
Returns R
- Defined in node_modules/@types/jest/index.d.ts:910

toBeLessThanOrEqual

toBeLessThanOrEqual(expected: number | bigint): R
For comparing floating point or big integer numbers.
Parameters
- expected: number | bigint
Returns R
- Defined in node_modules/@types/jest/index.d.ts:914

toBeNaN

toBeNaN(): R
Used to check that a variable is NaN.

Returns R
- Defined in node_modules/@types/jest/index.d.ts:933

toBeNull

toBeNull(): R
This is the same as .toBe(null) but the error messages are a bit nicer. So use .toBeNull() when you want to check that something is null.

Returns R
- Defined in node_modules/@types/jest/index.d.ts:919

toBeTruthy

toBeTruthy(): R
Use when you don't care what a value is, you just want to ensure a value is true in a boolean context. In JavaScript, there are six falsy values: false, 0, '', null, undefined, and NaN. Everything else is truthy.

Returns R
- Defined in node_modules/@types/jest/index.d.ts:925

toBeUndefined

toBeUndefined(): R
Used to check that a variable is undefined.

Returns R
- Defined in node_modules/@types/jest/index.d.ts:929

toContain

toContain<E = any>(expected: E): R
Used when you want to check that an item is in a list. For testing the items in the list, this uses ===, a strict equality check. It can also check whether a string is a substring of another string.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- expected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:943

toContainEqual

toContainEqual<E = any>(expected: E): R
Used when you want to check that an item is in a list. For testing the items in the list, this matcher recursively checks the equality of all fields, rather than checking for object identity.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- expected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:953

toEqual

toEqual<E = any>(expected: E): R
Used when you want to check that two objects have the same value. This matcher recursively checks the equality of all fields, rather than checking for object identity.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- expected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:962

toHaveBeenCalled

toHaveBeenCalled(): R
Ensures that a mock function is called.

Returns R
- Defined in node_modules/@types/jest/index.d.ts:966

toHaveBeenCalledTimes

toHaveBeenCalledTimes(expected: number): R
Ensures that a mock function is called an exact number of times.
Parameters
- expected: number
Returns R
- Defined in node_modules/@types/jest/index.d.ts:970

toHaveBeenCalledWith

toHaveBeenCalledWith<E extends any[]>(...params: E): R
Ensure that a mock function is called with specific arguments.

Optionally, you can provide a type for the expected arguments via a generic. Note that the type must be either an array or a tuple.
Type Parameters
- E extends any[]
Parameters
- ...params: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:978

toHaveBeenLastCalledWith

toHaveBeenLastCalledWith<E extends any[]>(...params: E): R
If you have a mock function, you can use .toHaveBeenLastCalledWith to test what arguments it was last called with.

Optionally, you can provide a type for the expected arguments via a generic. Note that the type must be either an array or a tuple.
Type Parameters
- E extends any[]
Parameters
- ...params: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:995

toHaveBeenNthCalledWith

toHaveBeenNthCalledWith<E extends any[]>(nthCall: number, ...params: E): R
Ensure that a mock function is called with specific arguments on an Nth call.

Optionally, you can provide a type for the expected arguments via a generic. Note that the type must be either an array or a tuple.
Type Parameters
- E extends any[]
Parameters
- nthCall: number
- ...params: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:986

toHaveLastReturnedWith

toHaveLastReturnedWith<E = any>(expected?: E): R
Use to test the specific value that a mock function last returned. If the last call to the mock function threw an error, then this matcher will fail no matter what value you provided as the expected return value.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- Optionalexpected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1005

toHaveLength

toHaveLength(expected: number): R
Used to check that an object has a .length property and it is set to a certain numeric value.
Parameters
- expected: number
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1010

toHaveNthReturnedWith

toHaveNthReturnedWith<E = any>(nthCall: number, expected?: E): R
Use to test the specific value that a mock function returned for the nth call. If the nth call to the mock function threw an error, then this matcher will fail no matter what value you provided as the expected return value.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- nthCall: number
- Optionalexpected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1020

toHaveProperty

toHaveProperty<E = any>(propertyPath: string | readonly any[], value?: E): R
Use to check if property at provided reference keyPath exists for an object. For checking deeply nested properties in an object you may use dot notation or an array containing the keyPath for deep references.

Optionally, you can provide a value to check if it's equal to the value present at keyPath on the target object. This matcher uses 'deep equality' (like toEqual()) and recursively checks the equality of all fields.
Type Parameters
- E = any
Parameters
- propertyPath: string | readonly any[]
- Optionalvalue: E
Returns R
Example
```
expect(houseForSale).toHaveProperty('kitchen.area', 20);
```
- Defined in node_modules/@types/jest/index.d.ts:1035

toHaveReturned

toHaveReturned(): R
Use to test that the mock function successfully returned (i.e., did not throw an error) at least one time

Returns R
- Defined in node_modules/@types/jest/index.d.ts:1039

toHaveReturnedTimes

toHaveReturnedTimes(expected: number): R
Use to ensure that a mock function returned successfully (i.e., did not throw an error) an exact number of times. Any calls to the mock function that throw an error are not counted toward the number of times the function returned.
Parameters
- expected: number
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1044

toHaveReturnedWith

toHaveReturnedWith<E = any>(expected?: E): R
Use to ensure that a mock function returned a specific value.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- Optionalexpected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1052

toMatch

toMatch(expected: string | RegExp): R
Check that a string matches a regular expression.
Parameters
- expected: string | RegExp
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1056

toMatchInlineSnapshot

toMatchInlineSnapshot(
propertyMatchers: Partial,
snapshot?: string,
): R
This ensures that a value matches the most recent snapshot with property matchers. Instead of writing the snapshot value to a .snap file, it will be written into the source code automatically. Check out the Snapshot Testing guide for more information.
Type Parameters
- U extends { [P in string | number | symbol]: any }
Parameters
- propertyMatchers: Partial
- Optionalsnapshot: string
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1096
toMatchInlineSnapshot(snapshot?: string): R
This ensures that a value matches the most recent snapshot with property matchers. Instead of writing the snapshot value to a .snap file, it will be written into the source code automatically. Check out the Snapshot Testing guide for more information.
Parameters
- Optionalsnapshot: string
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1102

toMatchObject

toMatchObject<E extends {} | any[]>(expected: E): R
Used to check that a JavaScript object matches a subset of the properties of an object

Optionally, you can provide an object to use as Generic type for the expected value. This ensures that the matching object matches the structure of the provided object-like type.
Type Parameters
- E extends {} | any[]
Parameters
- expected: E
Returns R
Example
```
type House = {
 bath: boolean;
 bedrooms: number;
 kitchen: {
 amenities: string[];
 area: number;
 wallColor: string;
 }
};

expect(desiredHouse).toMatchObject<House>({...standardHouse, kitchen: {area: 20}}) // wherein standardHouse is some base object of type House
```
- Defined in node_modules/@types/jest/index.d.ts:1078

toMatchSnapshot

toMatchSnapshot(
propertyMatchers: Partial,
snapshotName?: string,
): R
This ensures that a value matches the most recent snapshot with property matchers. Check out the Snapshot Testing guide for more information.
Type Parameters
- U extends { [P in string | number | symbol]: any }
Parameters
- propertyMatchers: Partial
- OptionalsnapshotName: string
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1084
toMatchSnapshot(snapshotName?: string): R
This ensures that a value matches the most recent snapshot. Check out the Snapshot Testing guide for more information.
Parameters
- OptionalsnapshotName: string
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1089

toReturn

toReturn(): R
Ensure that a mock function has returned (as opposed to thrown) at least once.

Returns R
Deprecated
in favor of toHaveReturned
- Defined in node_modules/@types/jest/index.d.ts:1108

toReturnTimes

toReturnTimes(count: number): R
Ensure that a mock function has returned (as opposed to thrown) a specified number of times.
Parameters
- count: number
Returns R
Deprecated
in favor of toHaveReturnedTimes
- Defined in node_modules/@types/jest/index.d.ts:1114

toReturnWith

toReturnWith<E = any>(value?: E): R
Ensure that a mock function has returned a specified value at least once.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- Optionalvalue: E
Returns R
Deprecated
in favor of toHaveReturnedWith
- Defined in node_modules/@types/jest/index.d.ts:1124

toStrictEqual

toStrictEqual<E = any>(expected: E): R
Use to test that objects have the same types as well as structure.

Optionally, you can provide a type for the expected value via a generic. This is particularly useful for ensuring expected objects have the right structure.
Type Parameters
- E = any
Parameters
- expected: E
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1132

toThrow

toThrow(error?: string | RegExp | Constructable | Error): R
Used to test that a function throws when it is called.
Parameters
- Optionalerror: string | RegExp | Constructable | Error
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1136

toThrowError

toThrowError(error?: string | RegExp | Constructable | Error): R
If you want to test that a specific error is thrown inside a function.
Parameters
- Optionalerror: string | RegExp | Constructable | Error
Returns R
Deprecated
in favor of toThrow
- Defined in node_modules/@types/jest/index.d.ts:1142

toThrowErrorMatchingInlineSnapshot

toThrowErrorMatchingInlineSnapshot(snapshot?: string): R
Used to test that a function throws a error matching the most recent snapshot when it is called. Instead of writing the snapshot value to a .snap file, it will be written into the source code automatically.
Parameters
- Optionalsnapshot: string
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1151

toThrowErrorMatchingSnapshot

toThrowErrorMatchingSnapshot(snapshotName?: string): R
Used to test that a function throws a error matching the most recent snapshot when it is called.
Parameters
- OptionalsnapshotName: string
Returns R
- Defined in node_modules/@types/jest/index.d.ts:1146

Interface Matchers<R, T>

Type Parameters

Index

Properties

Methods

Properties

toEqualBindings

toEqualBindingsArray

toEqualBindingsStream

toFailTest

toPassTest

toPassTestVoid

Methods

lastCalledWith

Type Parameters

Parameters

Returns R

Deprecated

lastReturnedWith

Type Parameters

Parameters

Returns R

Deprecated

nthCalledWith

Type Parameters

Parameters

Returns R

Deprecated

nthReturnedWith

Type Parameters

Parameters

Returns R

Deprecated

toBe

Type Parameters

Parameters

Returns R

toBeCalled

Returns R

Deprecated

toBeCalledTimes

Parameters

Returns R

Deprecated

toBeCalledWith

Type Parameters

Parameters

Returns R

Deprecated

toBeCloseTo

Parameters

Returns R

toBeDefined

Returns R

toBeFalsy

Returns R

toBeGreaterThan

Parameters

Returns R

toBeGreaterThanOrEqual

Parameters

Returns R

toBeInstanceOf

Type Parameters

Parameters

Returns R

toBeLessThan

Parameters

Returns R

toBeLessThanOrEqual

Parameters

Returns R

toBeNaN

Returns R

toBeNull

Returns R

toBeTruthy

Returns R

toBeUndefined

Returns R