# p-state-defer

> A deferred promise with state

Latest version **1.0.1** (published 2019-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install p-state-defer
pnpm add p-state-defer
yarn add p-state-defer
bun add p-state-defer
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-02-13 |
| First published | 2018-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 6 |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | skt-t1-byungi |
| Maintainers | skt-t1-byungi |
| Keywords | promise, deferred |

## Links

- npm: https://www.npmjs.com/package/p-state-defer
- Repository: https://github.com/skt-t1-byungi/p-state-defer
- npm.io page: https://npm.io/package/p-state-defer

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

- 1.0.1 (latest) — 2019-02-13
- 0.0.6-0 (next) — 2018-04-17
- 1.0.0 — 2019-02-13
- 0.1.2 — 2019-01-03
- 0.1.1 — 2019-01-03
- 0.1.0 — 2018-08-27
- 0.0.7 — 2018-04-18
- 0.0.6 — 2018-04-17
- 0.0.5 — 2018-04-17
- 0.0.4 — 2018-04-17
- 0.0.3 — 2018-04-17
- 0.0.1 — 2018-04-17

## README

# p-state-defer
A deferred promise with state

[![npm](https://flat.badgen.net/npm/v/p-state-defer)](https://www.npmjs.com/package/p-state-defer)

## Install
```sh
npm i p-state-defer
```
```js
// esm
import Deferred from 'p-state-defer'

// or cjs
const {Deferred} = require('p-state-defer')
```

## Usage
### Basic
```js
function loadImage(url){
  // Unlike Promise, No Indent!
  const defer = new Deferred();

  const img = new Image()
  img.src = url
  img.onload = _ => defer.resolve(img)
  img.onerror = _ => defer.reject(new Error('Failed to load image.'))

  return defer.promise;
}
```

### State
```js
const defer = new Deferred();

console.log( defer.isCompleted ) // false
console.log( defer.state ) // "pending"

defer.resolve('hello')

console.log( defer.isCompleted ) // => true
console.log( defer.state ) // => "resolved"
```


## API
### Deferred<T>
Deferred Constructor.

```js
const defer = new Deferred();
```

### Properties

#### promise : Promise<T>
Returns Promise.

```js
defer.promise.then(...)
```

#### state : 'pending' | 'resolved' | 'rejected'
Returns current state.

#### isCompleted : boolean
Returns whether completed or not.

### Methods
#### resolve(value: T)
Resolve promise.

#### reject(reason: any)
Reject promise.

## License
MIT

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