ReactiveX/rxjs

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

Open

#4 647 ouverte le 16 mars 2019

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)TypeScript (3 007 forks)batch import
docshelp wanted

Métriques du dépôt

Stars
 (31 024 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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}

Guide contributeur