Skip to content

Commit

Permalink
docs(eslint-plugin): [unbound-method] reference eslint-plugin-jests e…
Browse files Browse the repository at this point in the history
…xtension rule (#3232)

Relates to #2951
  • Loading branch information
G-Rath committed Mar 28, 2021
1 parent d0d7186 commit eda9157
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/eslint-plugin/docs/rules/unbound-method.md
Expand Up @@ -6,6 +6,8 @@ Class functions don't preserve the class scope when passed as standalone variabl

If your function does not access `this`, [you can annotate it with `this: void`](https://www.typescriptlang.org/docs/handbook/2/functions.html#declaring-this-in-a-function), or consider using an arrow function instead.

If you're working with `jest`, you can use [`eslint-plugin-jest`'s version of this rule](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/unbound-method.md) to lint your test files, which knows when it's ok to pass an unbound method to `expect` calls.

## Rule Details

Examples of **incorrect** code for this rule
Expand Down Expand Up @@ -105,6 +107,8 @@ log();

If your code intentionally waits to bind methods after use, such as by passing a `scope: this` along with the method, you can disable this rule.

If you're wanting to use `toBeCalled` and similar matches in `jest` tests, you can disable this rule for your test files in favor of [`eslint-plugin-jest`'s version of this rule](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/unbound-method.md).

## Related To

- TSLint: [no-unbound-method](https://palantir.github.io/tslint/rules/no-unbound-method/)

0 comments on commit eda9157

Please sign in to comment.