# ts-deferred

> Very simple implementation of Deferred for TypeScript

Latest version **1.0.4** (published 2017-05-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install ts-deferred
pnpm add ts-deferred
yarn add ts-deferred
bun add ts-deferred
```

## 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.4 |
| Published | 2017-05-01 |
| First published | 2016-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | shogogg |
| Maintainers | shogogg |
| Keywords | Deferred, Promise, TypeScript, Async |

## Links

- npm: https://www.npmjs.com/package/ts-deferred
- Repository: https://github.com/shogogg/ts-deferred
- Homepage: https://github.com/shogogg/ts-deferred#readme
- Issues: https://github.com/shogogg/ts-deferred/issues
- npm.io page: https://npm.io/package/ts-deferred

## 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.4 (latest) — 2017-05-01
- 1.0.3 — 2016-09-13
- 1.0.2 — 2016-07-11
- 1.0.1 — 2016-04-11
- 1.0.0 — 2016-04-11

## README

## ts-deferred
Very simple implementation of Deferred for TypeScript.

### Install
```
$ npm install --save ts-deferred
```

### Usage
#### in TypeScript
```
import {Deferred} from "ts-deferred";

let d: Deferred<string> = new Deferred<string>();
let p: Promise<string> = d.promise;

p.then(text => console.log(text));

d.resolve("Hello World!!");
```

#### in JavaScript
```
let Deferred = require("ts-deferred").Deferred;

let d = new Deferred();
let p = d.promise;

p.then(function (text) {
  console.log(text);
});

d.resolve("Hello World!!");
```


### API
#### `promise: Promise<T>`
The promise.

#### `resolve(value?: T | PromiseLike<T>): void`
Resolves the promise with the given value.

#### `reject(reason?: any): void`
Rejects the promise with the given reason.


### Dependency
This library has no implementation of `Promise<T>`.
If the target is es5 or less, it's depends
to [es6-promise](https://www.npmjs.com/package/es6-promise)
or [es6-shim](https://www.npmjs.com/package/es6-shim).


### How to build and test
1. Clone this repository.
2. Run `npm install` to install dependencies.
3. Run `npm run build` or `npm test`.


### License
MIT

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