ReactiveX/rxjs

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

Open

#4,647 opened on Mar 16, 2019

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

Repository metrics

Stars
 (31,024 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the existing throttle documentation and the throttleConfig parameter in the source code. Then add a description and example for the optional throttleConfig parameter. Also update the 'See Also' section with the suggested operators.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85