ReactiveX/rxjs

[docs]: Operator `throttleTime` is missing an example for the throttleConfig param

Open

#4.647 geöffnet am 16. März 2019

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (3.007 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (31.024 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Documentation Related To Component:

The throttleTime operator: throttleTime.ts

Please check those that apply

  • typo
  • documentation doesn't exist
  • documentation needs clarification
  • error(s) in example
  • needs example

We may want to include a description for throttleConfig param. Also, the see also section is incomplete.

Description

The detailed description can be improved. Here we should include that:

  • there is an optional config param

See Also

We miss some operators in the see also section.

A suggested list for related operators could look like this:

 * @see {@link delay}
 * @see {@link delayWhen}
 * @see {@link audit}
 * @see {@link auditTime}
 * @see {@link debounce}
 * @see {@link debounceTime}
 * @see {@link sample}
 * @see {@link sampleTime}
 * @see {@link throttle}

Contributor Guide