# tiny-defer-js

> > 一个轻量级 JavaScript 异步库, 从此拒绝回调嵌套。

Latest version **0.0.2** (published 2017-01-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install tiny-defer-js
pnpm add tiny-defer-js
yarn add tiny-defer-js
bun add tiny-defer-js
```

## 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.0.2 |
| Published | 2017-01-28 |
| First published | 2016-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | zz-zhangzhao |
| Maintainers | zhang-zhao |
| Keywords | deferred, promise |

## Links

- npm: https://www.npmjs.com/package/tiny-defer-js
- Repository: https://github.com/zz-zhangzhao/tiny-deferred
- Homepage: https://github.com/zz-zhangzhao/tiny-deferred#readme
- Issues: https://github.com/zz-zhangzhao/tiny-deferred/issues
- npm.io page: https://npm.io/package/tiny-defer-js

## 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.0.2 (latest) — 2017-01-28
- 0.0.1 — 2017-01-06
- 1.0.0 — 2016-12-06

## README

# tiny-deferred
> 一个轻量级 JavaScript 异步库, 从此拒绝回调嵌套。

### 下载

```shell
npm install tiny-defer-js --save
```

### 引入

* 浏览器端

 1. 标签引入
    ```js
    <script src="./node_modules/tiny-defer-js/index.js"></script>

    var Deferred = window.Deferred;
    ```

 2. es6
    ```js
    import Deferred from 'tiny-defer-js';
    ```

* node 端
    ```js
    var Deferred  = require('tiny-defer-js');
    ```

### API

```js
var deferred = new Deferred();
```

* **deferred.state;**

    返回对象当前状态，resolved, rejected, pending.

* **deferred.then(onResolve, onReject);**
    
    对象成功或者失败状态所执行的函数

* **deferred.resolve();**

    将对象转为成功状态

* **deferred.reject();**  

    将对象转为失败状态

* **deferred.done(fn);**  

    下一个状态为成功状态时执行的函数

* **deferred.fail(fn);**

    下一个状态为失败状态的执行的函数

* **deferred.always(fn);**
    
    无论下一个状态是成功状态还是失败状态，都执行的函数

* **Deferred.all();**

    接受多个Deferred对象实例，返回一个deferred对象实例，当全部结束时执行下一个成功状态。

### 使用

```js
// 引入主文件并新建 Deferred 实例
var Deferred = require('tiny-defer-js');

var deferred = new Deferred();
```

```js
// 这里我们使用 log 函数代表异步操作，通过传入不同的参数代表延迟时间的不同。
var log = function (delayTime) {
    var time = delayTime || 2000;
    setTimeout(function () {
        console.log('something');
        deferred.resolve();
    }, time);
    return deferred;
}
```

```js
// 链式顺序执行
log(1000)
    .then(log)
    .then(log);

// 同步执行，全部完成执行回调
Deferred.all(log(1000), log(2000))
    .then(function () {
        console.log('任务全部完成');
    });
```

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