github-pages-deploy-action/node_modules/eslint-plugin-jest/docs/rules/prefer-to-have-length.md
James Ives 01d0dd9282 🎉 3.6.0 Build
2020-09-12 18:19:45 -04:00

34 lines
674 B
Markdown

# 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.
```js
expect(files.length).toBe(1);
```
This rule is enabled by default.
### Default configuration
The following patterns are considered warnings:
```js
expect(files.length).toBe(1);
expect(files.length).toEqual(1);
expect(files.length).toStrictEqual(1);
```
The following pattern is not warning:
```js
expect(files).toHaveLength(1);
```