Browse Source

doc: update README

tags/v0.10.0 v0.10.0
Muthu Kumar 2 years ago
parent
commit
3c13dec8e3
Failed to extract signature
  1. 29
      README.md

29
README.md

@ -1,6 +1,6 @@
# 📤 Promise.object # 📤 Promise.object
A Promise.object implementation that deep traverses objects and resolves any Promises. `Promise.object` is `Promise.all` for objects, and it traverses deeply! It's also fully typed.
## Installation ## Installation
@ -10,25 +10,18 @@ npm install --save @codefeathers/promise.object
## Usage ## Usage
```JavaScript ```TS
Promise.object(<Object>).then(...) import { promiseObject } from "@codefeathers/promise.object";
```
> Note that importing this library does not pollute the Promise namespace. You should assign it to `Promise.object` yourself (or whatever you please). It does not interfere with native Promises, or your own Promises A+ compatible library such as Bluebird. It however uses Promises, so if you need to polyfill this is your chance.
## Example
```JavaScript
Promise.object = require('@codefeathers/promise.object');
const { log } = console;
Promise.object({ // --
const resolved = await Promise.object({
foo: Promise.resolve(5), foo: Promise.resolve(5),
bar: { bar: {
baz: Promise.resolve([ 1, 2, 3 ]) baz: Promise.resolve([ 1, 2, 3 ])
} }
}).then(log); });
console.log(resolved);
//-> { foo: 5, bar: { baz: [ 1, 2, 3 ] } } //-> { foo: 5, bar: { baz: [ 1, 2, 3 ] } }
``` ```
@ -38,17 +31,19 @@ We need to go _deeper_!
Promise.object = require('@codefeathers/promise.object'); Promise.object = require('@codefeathers/promise.object');
const { log } = console; const { log } = console;
Promise.object( // --
const resolved = await Promise.object(
Promise.resolve({ Promise.resolve({
foo: Promise.resolve({ foo: Promise.resolve({
bar: Promise.resolve(5) bar: Promise.resolve(5)
}) })
}) })
).then(log); );
console.log(resolved);
//-> { foo: { bar: 5 } } //-> { foo: { bar: 5 } }
``` ```
## Credits ## Credits
The original idea and challenge was all [@TRGWII](https://github.com/TRGWII). The original idea and challenge was from [@TRGWII](https://github.com/TRGWII).

Loading…
Cancel
Save