English · Node.js
Appearance
English · Node.js
Appearance
The GenericAssertions class provides assertion methods that can be used to make assertions about any values in the tests. A new instance of GenericAssertions is created by calling playwrightAssertions.expect():
import { test, expect } from '@playwright/test';
test('assert a value', async ({ page }) => {
const value = 1;
expect(value).toBe(2);
});expect.any() matches any object instance created from the constructor or a corresponding primitive type. Use it inside genericAssertions.toEqual() to perform pattern matching.
Usage
// Match instance of a class.
class Example {}
expect(new Example()).toEqual(expect.any(Example));
// Match any number.
expect({ prop: 1 }).toEqual({ prop: expect.any(Number) });
// Match any string.
expect('abc').toEqual(expect.any(String));Arguments
Constructor of the expected object like ExampleClass, or a primitive boxed type like Number.
expect.anything() matches everything except null and undefined. Use it inside genericAssertions.toEqual() to perform pattern matching.
Usage
const value = { prop: 1 };
expect(value).toEqual({ prop: expect.anything() });
expect(value).not.toEqual({ otherProp: expect.anything() });expect.arrayContaining() matches an array that contains all of the elements in the expected array, in any order. Note that received array may be a superset of the expected array and contain some extra elements.
Use this method inside genericAssertions.toEqual() to perform pattern matching.
Usage
expect([1, 2, 3]).toEqual(expect.arrayContaining([3, 1]));
expect([1, 2, 3]).not.toEqual(expect.arrayContaining([1, 4]));Arguments
expect.arrayOf() matches array of objects created from the constructor or a corresponding primitive type. Use it inside genericAssertions.toEqual() to perform pattern matching.
Usage
// Match instance of a class.
class Example {}
expect([new Example(), new Example()]).toEqual(expect.arrayOf(Example));
// Match any string.
expect(['a', 'b', 'c']).toEqual(expect.arrayOf(String));Arguments
Constructor of the expected object like ExampleClass, or a primitive boxed type like Number.
Compares floating point numbers for approximate equality. Use this method inside genericAssertions.toEqual() to perform pattern matching. When just comparing two numbers, prefer genericAssertions.toBeCloseTo().
Usage
expect({ prop: 0.1 + 0.2 }).not.toEqual({ prop: 0.3 });
expect({ prop: 0.1 + 0.2 }).toEqual({ prop: expect.closeTo(0.3, 5) });Arguments
Expected value.
The number of decimal digits after the decimal point that must be equal.
expect.objectContaining() matches an object that contains and matches all of the properties in the expected object. Note that received object may be a superset of the expected object and contain some extra properties.
Use this method inside genericAssertions.toEqual() to perform pattern matching. Object properties can be matchers to further relax the expectation. See examples.
Usage
// Assert some of the properties.
expect({ foo: 1, bar: 2 }).toEqual(expect.objectContaining({ foo: 1 }));
// Matchers can be used on the properties as well.
expect({ foo: 1, bar: 2 }).toEqual(expect.objectContaining({ bar: expect.any(Number) }));
// Complex matching of sub-properties.
expect({
list: [1, 2, 3],
obj: { prop: 'Hello world!', another: 'some other value' },
extra: 'extra',
}).toEqual(expect.objectContaining({
list: expect.arrayContaining([2, 3]),
obj: expect.objectContaining({ prop: expect.stringContaining('Hello') }),
}));Arguments
expect.stringContaining() matches a string that contains the expected substring. Use this method inside genericAssertions.toEqual() to perform pattern matching.
Usage
expect('Hello world!').toEqual(expect.stringContaining('Hello'));Arguments
expect.stringMatching() matches a received string that in turn matches the expected pattern. Use this method inside genericAssertions.toEqual() to perform pattern matching.
Usage
expect('123ms').toEqual(expect.stringMatching(/\d+m?s/));
// Inside another matcher.
expect({
status: 'passed',
time: '123ms',
}).toEqual({
status: expect.stringMatching(/passed|failed/),
time: expect.stringMatching(/\d+m?s/),
});Arguments
Compares value with expected by calling Object.is. This method compares objects by reference instead of their contents, similarly to the strict equality operator ===.
Usage
const value = { prop: 1 };
expect(value).toBe(value);
expect(value).not.toBe({});
expect(value.prop).toBe(1);Arguments
Compares floating point numbers for approximate equality. Use this method instead of genericAssertions.toBe() when comparing floating point numbers.
Usage
expect(0.1 + 0.2).not.toBe(0.3);
expect(0.1 + 0.2).toBeCloseTo(0.3, 5);Arguments
Expected value.
The number of decimal digits after the decimal point that must be equal.
Ensures that value is not undefined.
Usage
const value = null;
expect(value).toBeDefined();Ensures that value is false in a boolean context, one of false, 0, '', null, undefined or NaN. Use this method when you don't care about the specific value.
Usage
const value = null;
expect(value).toBeFalsy();Ensures that value > expected for number or big integer values.
Usage
const value = 42;
expect(value).toBeGreaterThan(1);Arguments
Ensures that value >= expected for number or big integer values.
Usage
const value = 42;
expect(value).toBeGreaterThanOrEqual(42);Arguments
Ensures that value is an instance of a class. Uses instanceof operator.
Usage
expect(page).toBeInstanceOf(Page);
class Example {}
expect(new Example()).toBeInstanceOf(Example);Arguments
Ensures that value < expected for number or big integer values.
Usage
const value = 42;
expect(value).toBeLessThan(100);Arguments
Ensures that value <= expected for number or big integer values.
Usage
const value = 42;
expect(value).toBeLessThanOrEqual(42);Arguments
Ensures that value is NaN.
Usage
const value = NaN;
expect(value).toBeNaN();Ensures that value is null.
Usage
const value = null;
expect(value).toBeNull();Ensures that value is true in a boolean context, anything but false, 0, '', null, undefined or NaN. Use this method when you don't care about the specific value.
Usage
const value = { example: 'value' };
expect(value).toBeTruthy();Ensures that value is undefined.
Usage
const value = undefined;
expect(value).toBeUndefined();Ensures that string value contains an expected substring. Comparison is case-sensitive.
Usage
const value = 'Hello, World';
expect(value).toContain('World');
expect(value).toContain(',');Arguments
Ensures that value is an Array or Set and contains an expected item.
Usage
const value = [1, 2, 3];
expect(value).toContain(2);
expect(new Set(value)).toContain(2);Arguments
Ensures that value is an Array or Set and contains an item equal to the expected.
For objects, this method recursively checks equality of all fields, rather than comparing objects by reference as performed by genericAssertions.toContain().
For primitive values, this method is equivalent to genericAssertions.toContain().
Usage
const value = [
{ example: 1 },
{ another: 2 },
{ more: 3 },
];
expect(value).toContainEqual({ another: 2 });
expect(new Set(value)).toContainEqual({ another: 2 });Arguments
Compares contents of the value with contents of expected, performing "deep equality" check.
For objects, this method recursively checks equality of all fields, rather than comparing objects by reference as performed by genericAssertions.toBe().
For primitive values, this method is equivalent to genericAssertions.toBe().
Usage
const value = { prop: 1 };
expect(value).toEqual({ prop: 1 });Non-strict equality
genericAssertions.toEqual() performs deep equality check that compares contents of the received and expected values. To ensure two objects reference the same instance, use genericAssertions.toBe() instead.
genericAssertions.toEqual() ignores undefined properties and array items, and does not insist on object types being equal. For stricter matching, use genericAssertions.toStrictEqual().
Pattern matching
genericAssertions.toEqual() can be also used to perform pattern matching on objects, arrays and primitive types, with the help of the following matchers:
genericAssertions.any()genericAssertions.anything()genericAssertions.arrayContaining()genericAssertions.arrayOf()genericAssertions.closeTo()genericAssertions.objectContaining()genericAssertions.stringContaining()genericAssertions.stringMatching()Here is an example that asserts some of the values inside a complex object:
expect({
list: [1, 2, 3],
obj: { prop: 'Hello world!', another: 'some other value' },
extra: 'extra',
}).toEqual(expect.objectContaining({
list: expect.arrayContaining([2, 3]),
obj: expect.objectContaining({ prop: expect.stringContaining('Hello') }),
}));Arguments
Ensures that value has a .length property equal to expected. Useful for arrays and strings.
Usage
expect('Hello, World').toHaveLength(12);
expect([1, 2, 3]).toHaveLength(3);Arguments
Ensures that property at provided keyPath exists on the object and optionally checks that property is equal to the expected. Equality is checked recursively, similarly to genericAssertions.toEqual().
Usage
const value = {
a: {
b: [42],
},
c: true,
};
expect(value).toHaveProperty('a.b');
expect(value).toHaveProperty('a.b', [42]);
expect(value).toHaveProperty('a.b[0]', 42);
expect(value).toHaveProperty('c');
expect(value).toHaveProperty('c', true);Arguments
Path to the property. Use dot notation a.b to check nested properties and indexed a[2] notation to check nested array items.
Optional expected value to compare the property to.
Ensures that string value matches a regular expression.
Usage
const value = 'Is 42 enough?';
expect(value).toMatch(/Is \d+ enough/);Arguments
Compares contents of the value with contents of expected, performing "deep equality" check. Allows extra properties to be present in the value, unlike genericAssertions.toEqual(), so you can check just a subset of object properties.
When comparing arrays, the number of items must match, and each item is checked recursively.
Usage
const value = {
a: 1,
b: 2,
c: true,
};
expect(value).toMatchObject({ a: 1, c: true });
expect(value).toMatchObject({ b: 2, c: true });
expect([{ a: 1, b: 2 }]).toMatchObject([{ a: 1 }]);Arguments
Compares contents of the value with contents of expected and their types.
Differences from genericAssertions.toEqual():
{ a: undefined, b: 2 } does not match { b: 2 }.[, 1] does not match [undefined, 1].a and b will not equal a literal object with fields a and b.Usage
const value = { prop: 1 };
expect(value).toStrictEqual({ prop: 1 });Arguments
Calls the function and ensures it throws an error.
Optionally compares the error with expected. Allowed expected values:
Usage
expect(() => {
throw new Error('Something bad');
}).toThrow();
expect(() => {
throw new Error('Something bad');
}).toThrow(/something/);
expect(() => {
throw new Error('Something bad');
}).toThrow(Error);Arguments
An alias for genericAssertions.toThrow().
Usage
expect(() => {
throw new Error('Something bad');
}).toThrowError();Arguments
Makes the assertion check for the opposite condition.
Usage
For example, the following code passes:
const value = 1;
expect(value).not.toBe(2);Type
GenericAssertionsUse .rejects to unwrap the reason of a rejected promise so any other matcher can be chained. If the promise is fulfilled the assertion fails.
For example, this code tests that the promise rejects with reason 'octopus':
test('rejects to octopus', async () => {
await expect(Promise.reject(new Error('octopus'))).rejects.toThrow('octopus');
});Type
GenericAssertionsUse resolves to unwrap the value of a fulfilled promise so any other matcher can be chained. If the promise is rejected the assertion fails.
For example, this code tests that the promise resolves and that the resulting value is 'lemon':
test('resolves to lemon', async () => {
await expect(Promise.resolve('lemon')).resolves.toBe('lemon');
});Type
GenericAssertions