# controlled-promise

> Better control of JavaScript promises

Latest version **0.2.0** (published 2018-04-15) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2018-04-15 |
| First published | 2017-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Unpacked size | 32.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Vitaliy Potapov |
| Maintainers | vitalets |
| Keywords | promise, promises, promise-library, promise-wrapper, promise-api |

## Links

- npm: https://www.npmjs.com/package/controlled-promise
- Repository: https://github.com/vitalets/controlled-promise
- Homepage: https://github.com/vitalets/controlled-promise#readme
- Issues: https://github.com/vitalets/controlled-promise/issues
- npm.io page: https://npm.io/package/controlled-promise

## 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

- 0.2.0 (latest) — 2018-04-15
- 0.1.2 — 2017-09-14
- 0.1.1 — 2017-09-12

## README

# controlled-promise
[![Build Status](https://travis-ci.org/vitalets/controlled-promise.svg?branch=master)](https://travis-ci.org/vitalets/controlled-promise)
[![npm](https://img.shields.io/npm/v/controlled-promise.svg)](https://www.npmjs.com/package/controlled-promise)
[![license](https://img.shields.io/npm/l/controlled-promise.svg)](https://www.npmjs.com/package/controlled-promise)
<img align="right" src="https://user-images.githubusercontent.com/1473072/31122235-ad06e442-a843-11e7-8c7e-c24149b6eeda.png"/>

> Better control of JavaScript [Promises]

A [Promise] wrapping library for advanced control of promise lifecycle. 
Allows to split business logic from promise manipulation:
 
* promisify event-emitters: easy access to `resolve` / `reject` callbacks
* return existing promise while it is pending
* auto-reject after configured timeout
* tiny size and zero dependencies

## Installation
```bash
npm install controlled-promise --save
```

## Usage
```js
const ControlledPromise = require('controlled-promise');

// Create controlled promise
const cp = new ControlledPromise();

// Call asynchronous function. Returns promise wich `resolve / reject` callbacks are stored in `cp`.
const promise = cp.call(() => someAsyncFn());

// Resolve promise later via cp.resolve()
cp.resolve();

// OR reject promise later via cp.reject()
cp.reject(error);
```
## API

<a name="ControlledPromise"></a>

### ControlledPromise
Controlled Promise.

**Kind**: global class  

* [ControlledPromise](#ControlledPromise)
    * [new ControlledPromise()](#new_ControlledPromise_new)
    * [.promise](#ControlledPromise+promise) ⇒ <code>Promise</code>
    * [.value](#ControlledPromise+value) ⇒ <code>\*</code>
    * [.isPending](#ControlledPromise+isPending) ⇒ <code>Boolean</code>
    * [.isFulfilled](#ControlledPromise+isFulfilled) ⇒ <code>Boolean</code>
    * [.isRejected](#ControlledPromise+isRejected) ⇒ <code>Boolean</code>
    * [.isSettled](#ControlledPromise+isSettled) ⇒ <code>Boolean</code>
    * [.isCalled](#ControlledPromise+isCalled) ⇒ <code>Boolean</code>
    * [.call(fn)](#ControlledPromise+call) ⇒ <code>Promise</code>
    * [.resolve([value])](#ControlledPromise+resolve)
    * [.reject([value])](#ControlledPromise+reject)
    * [.reset()](#ControlledPromise+reset)
    * [.timeout(ms, [reason])](#ControlledPromise+timeout)

<a name="new_ControlledPromise_new"></a>

#### new ControlledPromise()
Creates controlled promise. In contrast to original Promise, it does not immediately call any function.
Instead it has [.call()](#ControlledPromise+call) method for that and `resolve / reject` methods for
resolving promise.

<a name="ControlledPromise+promise"></a>

#### controlledPromise.promise ⇒ <code>Promise</code>
Returns promise itself.

**Kind**: instance property of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+value"></a>

#### controlledPromise.value ⇒ <code>\*</code>
Returns value with that promise was fulfilled (resolved or rejected).

**Kind**: instance property of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+isPending"></a>

#### controlledPromise.isPending ⇒ <code>Boolean</code>
Returns true if promise is pending.

**Kind**: instance property of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+isFulfilled"></a>

#### controlledPromise.isFulfilled ⇒ <code>Boolean</code>
Returns true if promise is fulfilled.

**Kind**: instance property of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+isRejected"></a>

#### controlledPromise.isRejected ⇒ <code>Boolean</code>
Returns true if promise rejected.

**Kind**: instance property of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+isSettled"></a>

#### controlledPromise.isSettled ⇒ <code>Boolean</code>
Returns true if promise fulfilled or rejected.

**Kind**: instance property of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+isCalled"></a>

#### controlledPromise.isCalled ⇒ <code>Boolean</code>
Returns true if promise already called via `.call()` method.

**Kind**: instance property of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+call"></a>

#### controlledPromise.call(fn) ⇒ <code>Promise</code>
This method executes `fn` and returns promise. While promise is pending all subsequent calls of `.call(fn)`
will return the same promise. To fulfill that promise you can use `.resolve() / .reject()` methods.

**Kind**: instance method of [<code>ControlledPromise</code>](#ControlledPromise)  

| Param | Type |
| --- | --- |
| fn | <code>function</code> | 

<a name="ControlledPromise+resolve"></a>

#### controlledPromise.resolve([value])
Resolves pending promise with specified `value`.

**Kind**: instance method of [<code>ControlledPromise</code>](#ControlledPromise)  

| Param | Type |
| --- | --- |
| [value] | <code>\*</code> | 

<a name="ControlledPromise+reject"></a>

#### controlledPromise.reject([value])
Rejects pending promise with specified `value`.

**Kind**: instance method of [<code>ControlledPromise</code>](#ControlledPromise)  

| Param | Type |
| --- | --- |
| [value] | <code>\*</code> | 

<a name="ControlledPromise+reset"></a>

#### controlledPromise.reset()
Resets to initial state.

**Kind**: instance method of [<code>ControlledPromise</code>](#ControlledPromise)  
<a name="ControlledPromise+timeout"></a>

#### controlledPromise.timeout(ms, [reason])
Sets timeout to reject promise automatically.

**Kind**: instance method of [<code>ControlledPromise</code>](#ControlledPromise)  

| Param | Type | Description |
| --- | --- | --- |
| ms | <code>Number</code> | delay in ms after that promise will be rejected automatically |
| [reason] | <code>String</code> \| <code>Error</code> \| <code>function</code> | rejection value. If it is string or error - promise will be rejected with that error. If it is function - this function will be called after delay where you can manually resolve or reject promise via `.resolve() / .reject()` methods. |

## Related
* [event-to-promise](https://github.com/JsCommunity/event-to-promise)
* [promise-events](https://github.com/yanickrochon/promise-events)

## License
MIT @ [Vitaliy Potapov](https://github.com/vitalets)

[Promise]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
[Promises]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise

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