Skip to content

Commit

Permalink
docs(README): Add no-connectable.
Browse files Browse the repository at this point in the history
  • Loading branch information
cartant committed Feb 28, 2019
1 parent fdf2cda commit 6b87900
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ The package includes the following rules (none of which are enabled by default):
| `rxjs-just` | Enforces the use of a `just` alias for `of`. Some other Rx implementations use `just` and if that's your preference, this is the rule for you. (There was [some discussion](https://github.com/ReactiveX/rxjs/issues/3747) about deprecating `of` in favour of `just`, but it was decided to stick with `of`.) This rule includes a fixer. | None |
| `rxjs-no-add` | Disallows the importation of patched observables and operators. | [See below](#rxjs-no-add) |
| `rxjs-no-compat` | Disallows importation from locations that depend upon `rxjs-compat`. | None |
| `rxjs-no-connectable` | Disallows calling the `publish` and `publishReplay` operators without selectors. | None |
| `rxjs-no-create` | Disallows the calling of `Observable.create`. Use `new Observable` instead. | None |
| `rxjs-no-deep-operators` | Disallows deep importation from `rxjs/operators`. Deep imports won't be in available in RxJS v6. | None |
| `rxjs-no-do` | I do without `do` operators. [Do you not?](https://youtu.be/spG-Yj0zEyc) Well, `do` isn't always a code smell, but this rule can be useful as a warning. | None |
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ The package includes the following rules (none of which are enabled by default):
| `rxjs-just` | Enforces the use of a `just` alias for `of`. Some other Rx implementations use `just` and if that's your preference, this is the rule for you. (There was [some discussion](https://github.com/ReactiveX/rxjs/issues/3747) about deprecating `of` in favour of `just`, but it was decided to stick with `of`.) This rule includes a fixer. | None |
| `rxjs-no-add` | Disallows the importation of patched observables and operators. | [See below](#rxjs-no-add) |
| `rxjs-no-compat` | Disallows importation from locations that depend upon `rxjs-compat`. | None |
| `rxjs-no-connectable` | Disallows calling the `publish` and `publishReplay` operators without selectors. | None |
| `rxjs-no-create` | Disallows the calling of `Observable.create`. Use `new Observable` instead. | None |
| `rxjs-no-deep-operators` | Disallows deep importation from `rxjs/operators`. Deep imports won't be in available in RxJS v6. | None |
| `rxjs-no-do` | I do without `do` operators. [Do you not?](https://youtu.be/spG-Yj0zEyc) Well, `do` isn't always a code smell, but this rule can be useful as a warning. | None |
Expand Down
2 changes: 1 addition & 1 deletion source/rules/rxjsNoConnectableRule.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { couldBeFunction } from "../support/util";
export class Rule extends Lint.Rules.TypedRule {

public static metadata: Lint.IRuleMetadata = {
description: "Disallows using `publish` operators without selectors.",
description: "Disallows calling the `publish` and `publishReplay` operators without selectors.",
options: null,
optionsDescription: "Not configurable.",
requiresTypeInfo: false,
Expand Down

0 comments on commit 6b87900

Please sign in to comment.