File Manager

Current Path: Root / node_modules/ eslint-plugin-jest/ docs/ rules

Parent Directory

Name	Size	Last Modified
[F]consistent-test-it.md Edit	1.70 KB	2022-10-08 17:28:27
[F]expect-expect.md Edit	3.46 KB	2022-10-08 17:28:27
[F]max-nested-describe.md Edit	2.75 KB	2022-10-08 17:28:27
[F]no-alias-methods.md Edit	1.27 KB	2022-10-08 17:28:27
[F]no-commented-out-tests.md Edit	1.33 KB	2022-10-08 17:28:28
[F]no-conditional-expect.md Edit	3.35 KB	2022-10-08 17:28:28
[F]no-deprecated-functions.md Edit	1.82 KB	2022-10-08 17:28:28
[F]no-disabled-tests.md Edit	1.47 KB	2022-10-08 17:28:28
[F]no-done-callback.md Edit	2.07 KB	2022-10-08 17:28:28
[F]no-duplicate-hooks.md Edit	1.22 KB	2022-10-08 17:28:28
[F]no-export.md Edit	992 bytes	2022-10-08 17:28:28
[F]no-focused-tests.md Edit	1.42 KB	2022-10-08 17:28:28
[F]no-hooks.md Edit	2.81 KB	2022-10-08 17:28:28
[F]no-identical-title.md Edit	1.36 KB	2022-10-08 17:28:28
[F]no-if.md Edit	1.16 KB	2022-10-08 17:28:28
[F]no-interpolation-in-snapshots.md Edit	1.25 KB	2022-10-08 17:28:28
[F]no-jasmine-globals.md Edit	1.22 KB	2022-10-08 17:28:28
[F]no-jest-import.md Edit	719 bytes	2022-10-08 17:28:28
[F]no-large-snapshots.md Edit	3.60 KB	2022-10-08 17:28:28
[F]no-mocks-import.md Edit	731 bytes	2022-10-08 17:28:28
[F]no-restricted-matchers.md Edit	1.12 KB	2022-10-08 17:28:28
[F]no-standalone-expect.md Edit	2.14 KB	2022-10-08 17:28:28
[F]no-test-prefixes.md Edit	884 bytes	2022-10-08 17:28:28
[F]no-test-return-statement.md Edit	910 bytes	2022-10-08 17:28:28
[F]prefer-called-with.md Edit	998 bytes	2022-10-08 17:28:28
[F]prefer-comparison-matcher.md Edit	1.68 KB	2022-10-08 17:28:28
[F]prefer-equality-matcher.md Edit	735 bytes	2022-10-08 17:28:28
[F]prefer-expect-assertions.md Edit	4.79 KB	2022-10-08 17:28:28
[F]prefer-expect-resolves.md Edit	1.40 KB	2022-10-08 17:28:28
[F]prefer-hooks-on-top.md Edit	1.94 KB	2022-10-08 17:28:28
[F]prefer-lowercase-title.md Edit	2.35 KB	2022-10-08 17:28:29
[F]prefer-spy-on.md Edit	1.29 KB	2022-10-08 17:28:29
[F]prefer-strict-equal.md Edit	710 bytes	2022-10-08 17:28:29
[F]prefer-to-be.md Edit	1.59 KB	2022-10-08 17:28:29
[F]prefer-to-contain.md Edit	862 bytes	2022-10-08 17:28:29
[F]prefer-to-have-length.md Edit	674 bytes	2022-10-08 17:28:29
[F]prefer-todo.md Edit	688 bytes	2022-10-08 17:28:29
[F]require-hook.md Edit	4.53 KB	2022-10-08 17:28:29
[F]require-to-throw-message.md Edit	1023 bytes	2022-10-08 17:28:29
[F]require-top-level-describe.md Edit	1.81 KB	2022-10-08 17:28:29
[F]unbound-method.md Edit	1.55 KB	2022-10-08 17:28:29
[F]valid-describe-callback.md Edit	1.43 KB	2022-10-08 17:28:29
[F]valid-expect-in-promise.md Edit	1.88 KB	2022-10-08 17:28:29
[F]valid-expect.md Edit	3.62 KB	2022-10-08 17:28:30
[F]valid-title.md Edit	5.74 KB	2022-10-08 17:28:30

Editing: no-done-callback.md

# Avoid using a callback in asynchronous tests and hooks (`no-done-callback`)

When calling asynchronous code in hooks and tests, `jest` needs to know when the
asynchronous work is complete to progress the current run.

Originally the most common pattern to achieve this was to use callbacks:

```js
test('the data is peanut butter', done => {
  function callback(data) {
    try {
      expect(data).toBe('peanut butter');
      done();
    } catch (error) {
      done(error);
    }
  }

fetchData(callback);
});
```

This can be very error-prone however, as it requires careful understanding of
how assertions work in tests or otherwise tests won't behave as expected.

For example, if the `try/catch` was left out of the above code, the test would
time out rather than fail. Even with the `try/catch`, forgetting to pass the
caught error to `done` will result in `jest` believing the test has passed.

A more straightforward way to handle asynchronous code is to use Promises:

```js
test('the data is peanut butter', () => {
  return fetchData().then(data => {
    expect(data).toBe('peanut butter');
  });
});
```

When a test or hook returns a promise, `jest` waits for that promise to resolve,
as well as automatically failing should the promise reject.

If your environment supports `async/await`, this becomes even simpler:

```js
test('the data is peanut butter', async () => {
  const data = await fetchData();
  expect(data).toBe('peanut butter');
});
```

## Rule details

This rule checks the function parameter of hooks & tests for use of the `done`
argument, suggesting you return a promise instead.

The following patterns are considered warnings:

```js
beforeEach(done => {
  // ...
});

test('myFunction()', done => {
  // ...
});

test('myFunction()', function (done) {
  // ...
});
```

The following patterns are not considered warnings:

```js
beforeEach(async () => {
  await setupUsTheBomb();
});

test('myFunction()', () => {
  expect(myFunction()).toBeTruthy();
});

test('myFunction()', () => {
  return new Promise(done => {
    expect(myFunction()).toBeTruthy();
    done();
  });
});
```

Cancel

File Explorer

Navigation

File Manager

Editing: no-done-callback.md

File Explorer

Navigation

File Manager

Editing: no-done-callback.md

Confirm Deletion

Rename Item

Change Permissions (Chmod)