Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify carryoverConcurrencyCount documentation #100

Merged
merged 2 commits into from
Jul 16, 2020
Merged

Clarify carryoverConcurrencyCount documentation #100

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2567c7e
Clarify `carryoverConcurrencyCount` documentation
Rafael09ED Mar 21, 2020
f91fe84
Clarify incomplete in carryoverConcurrencyCount documentation
Rafael09ED Jul 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ The length of time in milliseconds before the interval count resets. Must be fin
Type: `boolean`\
Default: `false`

Whether the task must finish in the given interval or will be carried over into the next interval count.
If `true`, specifies that an incomplete `Promise` should be carried over into the next interval and counted against the `intervalCap`. If `false`, an incomplete promise will continue to run independent of the next interval and will not count towards the `intervalCap`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean by incomplete?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A promise that has started executing but hasn't settled yet.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Rafael09ED Can you clarify in the text what you mean by "incomplete" or even better, use a better term than "Incomplete".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How's:
If true, specifies that any pending Promises, should be carried over into the next interval and counted against the intervalCap. If false, any of those pending Promises will not count towards the next intervalCap.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


### queue

Expand Down