ReactiveX/rxjs

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

Open

#4,647 建立於 2019年3月16日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)TypeScript (31,024 star) (3,007 fork)batch import
docshelp wanted

描述

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}

貢獻者指南