Skip to content

Commit 1807944

Browse files
docs(ban-operators): when not to use it
1 parent 2195b74 commit 1807944

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/rules/ban-operators.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
<!-- end auto-generated rule header -->
66

7-
This rule can be configured so that developers can ban any operators they want to avoid in their project.
7+
This rule can be configured so that developers can ban `rxjs` operators they want to avoid in their project.
8+
9+
> [!NOTE]
10+
> Operators outside of a `pipe` or not directly exported by `rxjs` are ignored.
811
912
## Options
1013

@@ -25,3 +28,17 @@ The following configuration bans `partition` and `onErrorResumeNext`:
2528
}
2629
```
2730

31+
## When Not To Use It
32+
33+
If you have no need to ban `rxjs` operators, you don't need this rule.
34+
35+
Type checked lint rules are more powerful than traditional lint rules, but also require configuring type checked linting.
36+
37+
## Related To
38+
39+
- [`ban-observables`](./ban-observables.md)
40+
41+
## Resources
42+
43+
- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/ban-operators.ts)
44+
- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/ban-operators.test.ts)

0 commit comments

Comments
 (0)