fix(throttle): properly handle default ThrottleConfig values #7176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jakovljevic-mladen
force-pushed
the
fix_an_issue_with_throttle
branch
from
e1f706f
to
f9cdf18
Compare
| @@ -47,15 +47,15 @@ import { timer } from '../observable/timer'; | |||
| * internally by the optional `scheduler`. | |||
| * @param scheduler The {@link SchedulerLike} to use for | |||
| * managing the timers that handle the throttling. Defaults to {@link asyncScheduler}. | |||
| * @param config a configuration object to define `leading` and | |||
| * @param config A configuration object to define `leading` and | |||
| * `trailing` behavior. Defaults to `{ leading: true, trailing: false }`. | |||
| * @return A function that returns an Observable that performs the throttle | |||
| * operation to limit the rate of emissions from the source. | |||
| */ | |||
| export function throttleTime<T>( | |||
| duration: number, | |||
| scheduler: SchedulerLike = asyncScheduler, | |||
There was a problem hiding this comment.
Should throttleTime merge scheduler and config parameters effectively introducing a ThrottleTimeConfig interface which would extend ThrottleConfig interface by adding scheduler?: SchedulerLike property to it?
It would effectively remove the need to use throttleTime like this: throttleTime(1000, undefined, { trailing: true }) to throttleTime(1000, { trailing: true }).
@benlesh, thoughts?
There was a problem hiding this comment.
Yes, this should probably be throttleTime(number, config) where config has a scheduler option. We'll need to deprecate the other signatures that take a scheduler as the second argument, but allow the scheduler to be passed with the config.
benlesh
approved these changes
Apr 5, 2023
jakovljevic-mladen
added a commit
that referenced
this pull request
Apr 6, 2023
* fix(throttle): properly handle default ThrottleConfig values * docs(ThrottleConfig): document "leading" and "trailing" behavior (cherry picked from commit b7a4e94)
jakovljevic-mladen
added
7.x
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR is split into two commits. The first one fixes an issue described in #7146, while the second one adds
ThrottleConfigdocs.This issue should be probably cherry picked to the
7.xbranch.Related issue (if exists):
Fixes #7146