ReactiveX/rxjs

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

Open

#4647 opened on Mar 16, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (31,024 stars) (3,007 forks)batch import
docshelp wanted

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}

Contributor guide

Tech stack
typescriptjavascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
rxjs basicsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Examine the throttleTime.ts file at the given URL. Add a JSDoc example for the throttleConfig parameter. Also update the @see section to include the listed operators. Ensure the documentation follows the existing style in the file.