summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/promise-inflight/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/promise-inflight/README.md')
-rw-r--r--deps/npm/node_modules/promise-inflight/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/deps/npm/node_modules/promise-inflight/README.md b/deps/npm/node_modules/promise-inflight/README.md
new file mode 100644
index 0000000000..f0ae3a4443
--- /dev/null
+++ b/deps/npm/node_modules/promise-inflight/README.md
@@ -0,0 +1,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!