Skip to content
/ vow Public

ES6-compatible and Promises/A+ implementation for Node.js and browsers

License

Notifications You must be signed in to change notification settings

dfilatov/vow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8d14c62 · Jul 3, 2019
Oct 7, 2016
Jul 3, 2019
Jul 3, 2019
Mar 12, 2015
Dec 9, 2012
Jan 10, 2014
Oct 16, 2014
Jul 3, 2019
Jun 20, 2013
Jan 18, 2016
Jul 3, 2019
Aug 31, 2018
Jul 3, 2019
Jul 3, 2019
Jul 3, 2019
Jul 3, 2019

Repository files navigation

Vow NPM Version Build Status NPM Downloads

Vow is a Promises/A+ implementation. It also supports ES6 Promises specification.

Full API reference can be found at http://dfilatov.github.io/vow/.

Getting Started

In Node.js

You can install using Node Package Manager (npm):

npm install vow

In Browsers

<script type="text/javascript" src="vow.min.js"></script>

It also supports RequireJS module format and YM module format.

Vow has been tested in IE6+, Mozilla Firefox 3+, Chrome 5+, Safari 5+, Opera 10+.

Usage

Creating a promise

There are two possible ways to create a promise.

1. Using a deferred

function doSomethingAsync() {
    var deferred = vow.defer();
    
    // now you can resolve, reject, notify corresponging promise within `deferred`
    // e.g. `defer.resolve('ok');`
        
    return deferred.promise(); // and return corresponding promise to subscribe to reactions
}

doSomethingAsync().then(
    function() {}, // onFulfilled reaction
    function() {}, // onRejected reaction
    function() {}  // onNotified reaction
    );

The difference between deferred and promise is that deferred contains methods to resolve, reject and notify corresponding promise, but the promise by itself allows only to subscribe on these actions.

2. ES6-compatible way

function doSomethingAsync() {
    return new vow.Promise(function(resolve, reject, notify) {
        // now you can resolve, reject, notify the promise
    });
}

doSomethingAsync().then(
    function() {}, // onFulfilled reaction
    function() {}, // onRejected reaction
    function() {}  // onNotified reaction
    );

Extensions and related projects

  • vow-fs — vow-based file I/O for Node.js
  • vow-node — extension for vow to work with nodejs-style callbacks
  • vow-queue — vow-based task queue with weights and priorities
  • vow-asker — wraps asker API in the vow promises implementation

NOTE. Documentation for old versions of the library can be found at https://github.com/dfilatov/vow/blob/0.3.x/README.md.

About

ES6-compatible and Promises/A+ implementation for Node.js and browsers

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages