Skip to content

docs(readme): minor adjustments #47

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): minor adjustments #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 3 additions & 4 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ argument is optional.
- `initFn` Function that is used to initialize the tokens used to manage
the semaphore. The default is `() => '1'`.
- `pauseFn` An optional fuction that is called to opportunistically request
pausing the the incoming stream of data, instead of piling up waiting
pausing the incoming stream of data, instead of piling up waiting
promises and possibly running out of memory.
See [examples/pausing.js](./examples/pausing.js).
- `resumeFn` An optional function that is called when there is room again
Expand Down Expand Up @@ -140,9 +140,8 @@ option is mainly useful in a situation where the flow of rate limit function
calls is continuous and and occuring faster than `timeUnit` (e.g. reading a
file) and not enabling it would cause the maximum number of calls to resolve
immediately (thus exhaust the limit immediately) and therefore the next bunch
calls would need to wait for `timeWindow` milliseconds. However if the flow is
sparse then this option may make the
code run slower with no advantages.
of calls would need to wait for `timeWindow` milliseconds. However if the flow
is sparse then this option may make the code run slower with no advantages.

## Contributing

Expand Down