Skip to content

Commit 22fa1b8

Browse files
docs(no-internal): when not to use it
1 parent afd8ecf commit 22fa1b8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/rules/no-internal.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,18 @@ Examples of **correct** code for this rule:
2121
```ts
2222
import { of } from "rxjs";
2323
```
24+
25+
## When Not To Use It
26+
27+
If you need to import internal modules that are not covered by the public API,
28+
then you don't need this rule.
29+
However, keep in mind that internal modules may change without notice.
30+
31+
## Further reading
32+
33+
- [Importing instructions](https://rxjs.dev/guide/importing)
34+
35+
## Resources
36+
37+
- [Rule source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/src/rules/no-internal.ts)
38+
- [Test source](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/main/tests/rules/no-internal.test.ts)

0 commit comments

Comments
 (0)