Archived
1
0
This repository has been archived on 2023-05-15. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
home-page/node_modules/eslint-plugin-jest/docs/rules/prefer-to-be-undefined.md
Sean Edmunds 0584430b5c First commit
2021-12-13 17:00:40 -06:00

38 lines
781 B
Markdown

# Suggest using `toBeUndefined()` (`prefer-to-be-undefined`)
## Deprecated
This rule has been deprecated in favor of [`prefer-to-be`](prefer-to-be.md).
In order to have a better failure message, `toBeUndefined()` should be used upon
asserting expectations on undefined value.
## Rule details
This rule triggers a warning if `toBe()`, `toEqual()` or `toStrictEqual()` is
used to assert an undefined value.
```js
expect(undefined).toBe(undefined);
```
This rule is enabled by default.
### Default configuration
The following patterns are considered warnings:
```js
expect(undefined).toBe(undefined);
expect(undefined).toEqual(undefined);
expect(undefined).toStrictEqual(undefined);
```
The following pattern is not warning:
```js
expect(undefined).toBeUndefined();
```