Comunica
    Preparing search index...

    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;
        toBe<E = any>(expected: 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<U extends { [P in string | number | symbol]: any }>(
            propertyMatchers: Partial<U>,
            snapshot?: string,
        ): R;
        toMatchInlineSnapshot(snapshot?: string): R;
        toMatchObject<E extends {} | any[]>(expected: E): R;
        toMatchSnapshot<U extends { [P in string | number | symbol]: any }>(
            propertyMatchers: Partial<U>,
            snapshotName?: string,
        ): R;
        toMatchSnapshot(snapshotName?: string): R;
        toStrictEqual<E = any>(expected: E): R;
        toThrow(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

    Methods

    toBe toBeCloseTo toBeDefined toBeFalsy toBeGreaterThan toBeGreaterThanOrEqual toBeInstanceOf toBeLessThan toBeLessThanOrEqual toBeNaN toBeNull toBeTruthy toBeUndefined toContain toContainEqual toEqual toHaveBeenCalled toHaveBeenCalledTimes toHaveBeenCalledWith toHaveBeenLastCalledWith toHaveBeenNthCalledWith toHaveLastReturnedWith toHaveLength toHaveNthReturnedWith toHaveProperty toHaveReturned toHaveReturnedTimes toHaveReturnedWith toMatch toMatchInlineSnapshot toMatchObject toMatchSnapshot toStrictEqual toThrow toThrowErrorMatchingInlineSnapshot toThrowErrorMatchingSnapshot

    Properties

    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

    Methods

    • 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

    • 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

    • Ensure that a variable is not undefined.

      Returns 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

    • For comparing floating point or big integer numbers.

      Parameters

      • expected: number | bigint

      Returns R

    • For comparing floating point or big integer numbers.

      Parameters

      • expected: number | bigint

      Returns 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

    • For comparing floating point or big integer numbers.

      Parameters

      • expected: number | bigint

      Returns R

    • For comparing floating point or big integer numbers.

      Parameters

      • expected: number | bigint

      Returns R

    • Used to check that a variable is NaN.

      Returns 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

    • 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

    • Used to check that a variable is undefined.

      Returns 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

    • 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

    • 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

    • Ensures that a mock function is called.

      Returns R

    • Ensures that a mock function is called an exact number of times.

      Parameters

      • expected: number

      Returns 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

    • 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

    • 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

    • 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

    • Used to check that an object has a .length property and it is set to a certain numeric value.

      Parameters

      • expected: number

      Returns 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

    • 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

      expect(houseForSale).toHaveProperty('kitchen.area', 20);

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

      Returns 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

    • 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

    • Check that a string matches a regular expression.

      Parameters

      • expected: string | RegExp

      Returns 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<U>
      • Optionalsnapshot: string

      Returns 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

    • 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

      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

    • 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<U>
      • OptionalsnapshotName: string

      Returns 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

    • 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

    • Used to test that a function throws when it is called.

      Parameters

      Returns 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

    • Used to test that a function throws a error matching the most recent snapshot when it is called.

      Parameters

      • OptionalsnapshotName: string

      Returns R

    Settings

    Member Visibility

    On This Page

    Properties
    Methods