mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 lines
2.1 KiB
86 lines
2.1 KiB
8 years ago
|
call-limit
|
||
|
|
----------
|
||
|
|
|
||
|
|
Limit the number of simultaneous executions of a async function.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var fs = require('fs')
|
||
|
|
var limit = require('call-limit')
|
||
|
|
var limitedStat = limit(fs.stat, 5)
|
||
|
|
```
|
||
|
|
|
||
|
|
Or with promise returning functions:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var fs = Bluebird.promisifyAll(require('fs'))
|
||
|
|
var limit = require('call-limit')
|
||
|
|
var limitedStat = limit.promise(fs.statAsync, 5)
|
||
|
|
```
|
||
|
|
|
||
|
|
### USAGE:
|
||
|
|
|
||
|
|
Given that:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var limit = require('call-limit')
|
||
|
|
```
|
||
|
|
|
||
|
|
### limit(func, maxRunning) → limitedFunc
|
||
|
|
|
||
|
|
The returned function will execute up to maxRunning calls of `func` at once.
|
||
|
|
Beyond that they get queued and called when the previous call completes.
|
||
|
|
|
||
|
|
`func` must accept a callback as the final argument and must call it when
|
||
|
|
it completes, or `call-limit` won't know to dequeue the next thing to run.
|
||
|
|
|
||
|
|
By contrast, callers to `limitedFunc` do NOT have to pass in a callback, but
|
||
|
|
if they do they'll be called when `func` calls its callback.
|
||
|
|
|
||
|
|
### limit.promise(func, maxRunning) → limitedFunc
|
||
|
|
|
||
|
|
The returned function will execute up to maxRunning calls of `func` at once.
|
||
|
|
Beyond that they get queued and called when the previous call completes.
|
||
|
|
|
||
|
|
`func` must return a promise.
|
||
|
|
|
||
|
|
`limitedFunc` will return a promise that resolves with the promise returned
|
||
|
|
from the call to `func`.
|
||
|
|
|
||
|
|
### limit.method(class, methodName, maxRunning)
|
||
|
|
|
||
|
|
This is sugar for:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
class.prototype.methodName = limit(class.prototype.methodName, maxRunning)
|
||
|
|
```
|
||
|
|
|
||
|
|
### limit.method(object, methodName, maxRunning)
|
||
|
|
|
||
|
|
This is sugar for:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
object.methodName = limit(object.methodName, maxRunning)
|
||
|
|
```
|
||
|
|
|
||
|
|
For example `limit.promise.method(fs, 'stat', 5)` is the same as
|
||
|
|
`fs.stat = limit.promise(fs.stat, 5)`.
|
||
|
|
|
||
|
|
### limit.promise.method(class, methodName, maxRunning)
|
||
|
|
|
||
|
|
This is sugar for:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
class.prototype.methodName = limit.promise(class.prototype.methodName, maxRunning)
|
||
|
|
```
|
||
|
|
|
||
|
|
### limit.promise.method(object, methodName, maxRunning)
|
||
|
|
|
||
|
|
This is sugar for:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
object.methodName = limit.promise(object.methodName, maxRunning)
|
||
|
|
```
|
||
|
|
|
||
|
|
For example `limit.promise.method(fs, 'statAsync', 5)` is the same as
|
||
|
|
`fs.statAsync = limit.promise(fs.statAsync, 5)`.
|