Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wtfaremyinitials/blocking-await

Synchronously wait for a Promise to resolve
https://github.com/wtfaremyinitials/blocking-await

node promise

Last synced: about 1 month ago
JSON representation

Synchronously wait for a Promise to resolve

Awesome Lists containing this project

README

        

blocking-await
===

![](https://img.shields.io/npm/dm/blocking-await.svg)
![](https://img.shields.io/npm/v/blocking-await.svg)
![](https://img.shields.io/npm/l/blocking-await.svg)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

> Synchronously wait for a Promise to resolve

Use this module to block the entire node process while waiting for a Promise to resolve.

**NOTE**: In almost every case you should not use this and instead opt for true `async` functions
using JavaScript's built-in `await` construct. Your entire app will become unresponsive while waiting.

Installation
===

```bash
npm install blocking-await --save
```

Usage
===

```js
var wait = require('blocking-await')
var got = require('got')

var res = wait(got('todomvc.com'))
console.log(res.body)
//=> ' ...'
```

API
===

### Wait for a Promise to resolve

`wait(promise) -> value`

Synchronously waits for a Promise to resolve. This locks up the entire node process.

**promise**

Type: `Promise`

The promise to wait on.

**return**

Type: `T`

Returns the value the promise resolved (or throws what it rejected).