the-forest/client/node_modules/eslint-plugin-jest/docs/rules/prefer-to-have-length.md
2024-09-17 20:35:18 -04:00

674 B

Suggest using toHaveLength() (prefer-to-have-length)

In order to have a better failure message, toHaveLength() should be used upon asserting expectations on objects length property.

Rule details

This rule triggers a warning if toBe(), toEqual() or toStrictEqual() is used to assert objects length property.

expect(files.length).toBe(1);

This rule is enabled by default.

Default configuration

The following patterns are considered warnings:

expect(files.length).toBe(1);

expect(files.length).toEqual(1);

expect(files.length).toStrictEqual(1);

The following pattern is not warning:

expect(files).toHaveLength(1);