summaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/node_modules/promise-inflight/README.md
blob: f0ae3a44432d6834e24aee54bdc58af704a858d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# promise-inflight

One promise for multiple requests in flight to avoid async duplication

## USAGE

```javascript
const inflight = require('promise-inflight')

// some request that does some stuff
function req(key) {
  // key is any random string.  like a url or filename or whatever.
  return inflight(key, () => {
    // this is where you'd fetch the url or whatever
    return Promise.delay(100)
  })
}

// only assigns a single setTimeout
// when it dings, all thens get called with the same result.  (There's only
// one underlying promise.)
req('foo').then(…)
req('foo').then(…)
req('foo').then(…)
req('foo').then(…)
```

## SEE ALSO

* [inflight](https://npmjs.com/package/inflight) - For the callback based function on which this is based.

## STILL NEEDS

Tests!