https://github.com/rse/chunking
Simple Task Chunking
https://github.com/rse/chunking
chunking rate-limiting task throttling
Last synced: 3 months ago
JSON representation
Simple Task Chunking
- Host: GitHub
- URL: https://github.com/rse/chunking
- Owner: rse
- Created: 2018-05-02T21:51:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-09T13:29:12.000Z (over 4 years ago)
- Last Synced: 2025-07-04T08:12:01.043Z (3 months ago)
- Topics: chunking, rate-limiting, task, throttling
- Language: JavaScript
- Homepage: http://npmjs.com/chunking
- Size: 20.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Chunking
========
Simple Task Chunking
About
-----
Chunking is a very small JavaScript library, providing the capability
to chunk (aka rate limit or throttle) method calls by first absorbing
arguments to a function up to a certain amount of time and then finally
emitting the arguments to an underlying function.
Installation
------------
```shell
$ npm install chunking
```
Usage
-----
```js
const chunking = require("chunking")
const expect = require("chai").expect
const receive = (items) => {
expect(items).to.be.deep.equal([ "foo", "bar", "baz", "quux" ])
console.log(items)
}
let notify = chunking({
reset: (ctx) => { ctx.items = [] },
absorb: (ctx, items) => { items.forEach((item) => ctx.items.push(item)) },
emit: (ctx) => { receive(ctx.items) },
delay: 2 * 1000
})
notify([ "foo", "bar" ])
notify([ "baz" ])
notify([ "quux" ])
```
License
-------
Copyright (c) 2018-2021 Dr. Ralf S. Engelschall (http://engelschall.com/)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.