You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 lines
998 B
32 lines
998 B
# Suggest using `toBeCalledWith()` or `toHaveBeenCalledWith()` (`prefer-called-with`) |
|
|
|
The `toBeCalled()` matcher is used to assert that a mock function has been |
|
called one or more times, without checking the arguments passed. The assertion |
|
is stronger when arguments are also validated using the `toBeCalledWith()` |
|
matcher. When some arguments are difficult to check, using generic match like |
|
`expect.anything()` at least enforces number and position of arguments. |
|
|
|
This rule warns if the form without argument checking is used, except for `.not` |
|
enforcing a function has never been called. |
|
|
|
## Rule details |
|
|
|
The following patterns are warnings: |
|
|
|
```js |
|
expect(someFunction).toBeCalled(); |
|
|
|
expect(someFunction).toHaveBeenCalled(); |
|
``` |
|
|
|
The following patterns are not warnings: |
|
|
|
```js |
|
expect(noArgsFunction).toBeCalledWith(); |
|
|
|
expect(roughArgsFunction).toBeCalledWith(expect.anything(), expect.any(Date)); |
|
|
|
expect(anyArgsFunction).toBeCalledTimes(1); |
|
|
|
expect(uncalledFunction).not.toBeCalled(); |
|
```
|
|
|