https://github.com/mono-js/mono-utils
Node.js utils to deal with async/await
https://github.com/mono-js/mono-utils
Last synced: 2 months ago
JSON representation
Node.js utils to deal with async/await
- Host: GitHub
- URL: https://github.com/mono-js/mono-utils
- Owner: mono-js
- License: mit
- Created: 2018-05-24T15:00:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-13T08:18:56.000Z (about 7 years ago)
- Last Synced: 2024-04-24T15:10:05.190Z (about 1 year ago)
- Language: JavaScript
- Size: 48.8 KB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Node.js utils to deal with async/await.
[](https://www.npmjs.com/package/mono-utils)
[](https://travis-ci.org/mono-js/mono-utils)
[](https://codecov.io/mono-js/mono-utils)
[](https://github.com/mono-js/mono-utils/blob/master/LICENSE)
## Installation
```bash
npm install --save mono-utils
```
## Usage
**INFO:** You need `node` >= `8.0.0` to use mono-utils since it uses native `async/await`
```js
const { ok, cb, waitFor, ... } = require('mono-utils')
```
## Utils
- [ok](#ok)
- [cb](#cb)
- [waitFor](#waitfor)
- [waitForEvent](#waitforevent)
- [asyncObject](#asyncobject)
- [asyncMap](#asyncmap)
- [asyncForEach](#asyncforeach)
### ok
Waits for the value of the `Promise` and returns its value. If the promise throws an `Error`, returns `undefined`.
```js
ok(promise: Object): Promise
```
Example:
```js
const { ok } = require('mono-core/utils')
const { readFile } = require('fs-extra')
// readFile sends back a Promise since we use fs-extra
const file = await ok(readFile('./my-file.txt', 'utf-8'))
if (file) console.log('File found:', file)
```
### cb
Calls a function Node style function as first argument `function (err, result)`, all the others arguments will be given to the function. Waits for the callback result, throws an `Error` if `err` is truthy.
```js
cb(fn: Function, ...args: any[]): Promise
```
Example:
```js
const { ok } = require('mono-core/utils')
const fs = require('fs')
try {
const file = await cb(fs.readFile, '/path/to/my/file.txt', 'utf-8')
} catch (err) {
// Could not read file
}
```
### waitFor
Waits for `ms` milliseconds to pass, use `setTimeout` under the hood.
```js
waitFor(ms: number): Promise
```
Example:
```js
const { waitFor } = require('mono-core/utils')
await waitFor(1000) // wait for 1s
```
### waitForEvent
Waits for emitter to emit an eventName event.
```js
waitForEvent(emitter: EventEmitter, eventName: string, timeout: number = -1): Promise
```
Example:
```js
const { waitFor } = require('mono-core/utils')
await waitForEvent(sever, 'listen')
```
### asyncObject
Waits for all Promises in the keys of obj to resolve.
```js
asyncObject(obj: Object): Promise
```
Example:
```js
const { asyncObject } = require('mono-core/utils')
const { pictures, comments, tweets } = await asyncObject({
pictures: getPictures(),
comments: getComments(),
tweets: getTweets()
})
console.log(pictures, comments, tweets)
```
### asyncMap
Waits for all Promises mapped by `fn`:
```js
asyncMap(array: Array, fn: Function): Promise
```
Example:
```js
const { asyncMap } = require('mono-core/utils')
const posts = await asyncMap([1, 2, 3], (id) => fetchPost(id))
```
### asyncForEach
Loop for every item in array and call `fn` and wait for it to finish **in series**:
```js
asyncForEach(array: Array, fn: Function): Promise
```
Example:
```js
const { asyncMap } = require('mono-core/utils')
const posts = await asyncForEach(users, async (user) => {
await saveUser(user)
})
```
## Other utils
We developed other utils that you might find useful:
- [mongodb-utils](https://github.com/mono-js/mongodb-utils)
- [elasticsearch-utils](https://github.com/mono-js/elasticsearch-utils)
- [mono-test-utils](https://github.com/mono-js/mono-test-utils)
## LICENSE
[MIT](https://github.com/mono-js/mono-utils/blob/master/LICENSE)