@absolunet/pinki 中文文档教程

Question

pinki

Pinky Promises

异步库包装器

Dependencies / Implements

• PubSubJS - Dependency free publish/subscribe for JavaScript
• RSVP.js - A tiny implementation of Promises/A+ with deferred objects

Install

$ npm install @absolunet/pinki

Usage

// Node.js
const pinki = require('@absolunet/pinki');

// Browser - Load vendor libraries
// - /node_modules/pubsub-js/src/pubsub.js
// - /node_modules/rsvp/dist/rsvp.js
const { pinki } = window;


// Messages
pinki.message.publish('alpha', 'Yeah!');

pinki.message.subscribe('alpha', (data) => {
    console.log(data);
});

setTimeout(() => {
    pinki.message.publish('alpha', 'Yessir!');
}, 100);


// Outputs:
// Yeah!
// Yessir!




pinki.vow.fulfill('gamma', 'Yeah!');


pinki.vow.when('gamma').then((data) => {
    console.log(data);
});

pinki.vow.when(['gamma', 'delta']).then(([dataC, dataD]) => {
    console.log(dataC, dataD);
});


setTimeout(() => {
    pinki.vow.fulfill('delta', 'Yessir!');
}, 100);


// Outputs:
// 'Yeah!'
// { gamma:'Yeah!', delta:'Yessir!' }

API - Messages

message.subscribe(topic, subscriber [, options])

Wraps PubSub.subscribe< /a>，但也执行与订阅匹配的先前发布的消息。

options.executePrevious

类型：布尔值
默认值：true
执行先前发布的消息。

message.publish(topic, data)

包装 PubSub.publish。

message.unsubscribe(topic|token)

地图 PubSub.unsubscribe。

API - Vows

誓言 是基于名字的承诺，可以随时引用。

vow.list

誓言比已登记。

vow.when(names)

如果给出一个誓言或 RSVP.all 则返回一个 Promise当所有誓言都得到履行时做出反应的承诺，或者如果给出多个誓言则一个誓言被打破。

names

类型：String 或 Array
一个或多个誓言名称

vow.fulfill(name, data)

Resolve 底层的 Promise。

name

类型：字符串
誓言名称

data

类型：
解析底层 Promise 和

vow.break(name, error)

Reject the underlying Promise 的数据。

name

类型：字符串
誓言名称

error

类型：String
拒绝底层 Promise 的错误消息

License

MIT © Absolunet

“Pinky Finger” 图标由 Mitchell D. Eva 来自 名词项目。