# promise-synchronizer

> synchronize promise

Latest version **3.0.0** (published 2020-08-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install promise-synchronizer
pnpm add promise-synchronizer
yarn add promise-synchronizer
bun add promise-synchronizer
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2020-08-17 |
| First published | 2016-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | fisker Cheung |
| Maintainers | fisker |
| Keywords | promise, promise-synchronizer, sync, synchronize, synchronizer |

## Links

- npm: https://www.npmjs.com/package/promise-synchronizer
- Repository: https://github.com/fisker/promise-synchronizer
- Homepage: https://github.com/fisker/promise-synchronizer#readme
- Issues: https://github.com/fisker/promise-synchronizer/issues
- Funding: https://github.com/fisker/promise-synchronizer?sponsor=1
- npm.io page: https://npm.io/package/promise-synchronizer

## Dependencies (2)

- [deasync](https://npm.io/package/deasync.md) 0.1.20
- [p-is-promise](https://npm.io/package/p-is-promise.md) 3.0.0

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 3.0.0 (latest) — 2020-08-17
- 2.0.0 — 2020-04-29
- 1.2.0 — 2020-04-25
- 1.1.9 — 2020-02-19
- 1.1.8 — 2020-01-10
- 1.1.7 — 2019-12-25
- 1.1.6 — 2019-12-20
- 1.1.5 — 2019-12-19
- 1.1.4 — 2019-10-28
- 1.1.3 — 2019-08-05
- 1.1.2 — 2019-07-18
- 1.1.1 — 2019-05-05
- 1.1.0 — 2019-04-25
- 1.0.16 — 2019-04-25
- 1.0.15 — 2019-04-13
- … 19 more at https://npm.io/package/promise-synchronizer/versions

## README

# promise-synchronizer

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![npm](https://img.shields.io/npm/v/promise-synchronizer.svg?style=flat-square)](https://www.npmjs.com/package/promise-synchronizer)
[![npm](https://img.shields.io/npm/dt/promise-synchronizer.svg?style=flat-square)](https://www.npmjs.com/package/promise-synchronizer)
[![npm](https://img.shields.io/npm/dm/promise-synchronizer.svg?style=flat-square)](https://www.npmjs.com/package/promise-synchronizer)

[![Build Status](https://img.shields.io/travis/fisker/promise-synchronizer.svg?style=flat-square)](https://travis-ci.org/fisker/promise-synchronizer)
[![Code Coverage](https://img.shields.io/coveralls/github/fisker/promise-synchronizer.svg?style=flat-square)](https://coveralls.io/github/fisker/promise-synchronizer)
[![MIT License](https://img.shields.io/npm/l/promise-synchronizer.svg?style=flat-square)](https://github.com/fisker/promise-synchronizer/blob/master/license)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

> synchronize promise

## Install

```bash
yarn add promise-synchronizer
```

## Usage

### Wrap async functions

```js
import sync from 'promise-synchronizer'

const asyncFunction = async () => 'Fulfilled'

asyncFunction()

// -> Promise { 'Fulfilled' }

const syncFunction = sync(asyncFunction)

syncFunction()
// -> 'Fulfilled'
```

### Wait for promises

```js
import sync from 'promise-synchronizer'

const promiseWillFulfill = Promise.resolve('Fulfilled')
sync(promiseWillFulfill)
// -> Fulfilled

const promiseWillReject = Promise.reject(new Error('Rejected'))
sync(promiseWillReject)
// -> Uncaught Error: Reject
```

Use `try-catch`

```js
import sync from 'promise-synchronizer'

try {
  console.log(sync(promise)) // Fulfilled
} catch (error) {
  console.error(error) // Rejected
}
```

---
_Source: https://npm.io/package/promise-synchronizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._