ReactiveX/rxjs

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

クローズ

#4,647 opened on 2019/03/16

 (3 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (2,990 件のフォーク)batch import
docshelp wanted

Repository metrics

Stars
 (31,704 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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}

コントリビューターガイド