README

一个 Promise 相关的轮子。

安装

yarn add vait
# or
npm install --save vait

示例

global.vait = require('vait')

const v = vait()

v.then(str => {
  // 如果不执行 v.pass, 此函数将永远不会执行
  console.log(str)
})


v.pass('hello, world') // 支持一个参数传入

v.pass() // 因为是调用了 Promise resolve，所以 console.log('hello') 只会执行一次

// 抛出错误
const v = vait()

v.catch(err => {
  // 此处的 err 为下面的 new Error('fail')
  console.warn(err)
})

v.fail(new Error('fail'))

// 一个卡住运行时的用法

const v = vait()

;(async () => {
  console.log('accept value is:', await v)
})()

setTimeout(() => {
  // 一秒后才会出现 accept value is: 3.1415926
  v.pass(3.1415926)
}, 1000)

API

vait.timeout()

setTimeout 的 Promise 封装

// 一般写法
vait.timeout(1000).then(() => {
  console.log('hello')
})

// 取消定时器
const v = vait.timeout(1000)
v.clear()

vait.nextTick()

相当于调用 vait.timeout(0)

vait 实例中的 `value`、`error`、`finally`

当 Promise resolve 后，__value__ 为 resolve 的值。如果是 reject 的话，reject 的值将在 __error__。在上述两个情况发生之前，__finally__ 都会是 false，否则为 true。

const printVaitState = (title, v) => {
  console.group(title)
  console.log('__value__', v.__value__)
  console.log('__error__', v.__error__)
  console.log('__finally__', v.__finally__)
  console.log(
    'exist',
    v.hasOwnProperty('__value__'),
    v.hasOwnProperty('__error__'),
    v.hasOwnProperty('__finally__')
  )
  console.groupEnd(title)
}

const v = vait()
printVaitState('initial', v)
v.pass('hello')
printVaitState('pass', v)

const failV = vait()
failV.fail(Error('error message'))
printVaitState('fail', failV)

// 输出结果:
// initial
//   __value__ undefined
//   __error__ undefined
//   __finally__ false
//   exist false false true
//
// pass
//   __value__ hello
//   __error__ undefined
//   __finally__ true
//   exist true false true
//
// fail
//   __value__ undefined
//   __error__ Error: error message
//   __finally__ true
//   exist false true true

vait.wait()

等待一个 Promise 的完成。

const timeoutV = vait.timeout(1000)
const timeoutWaitV = vait.wait(timeoutV)

timeoutWaitV.then(() => {
  conosle.log("1000ms after")
})

LICENSE

MIT

Usage no npm install needed!