https://github.com/kriszyp/node-promise

Promise utilities for Node
https://github.com/kriszyp/node-promise

Last synced: 2 days ago
JSON representation

Promise utilities for Node

• Host: GitHub
• URL: https://github.com/kriszyp/node-promise
• Owner: kriszyp
• Created: 2010-01-09T15:35:50.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2020-09-29T02:31:22.000Z (about 4 years ago)
• Last Synced: 2024-12-16T07:05:38.443Z (9 days ago)
• Language: JavaScript
• Homepage:
• Size: 31.3 KB
• Stars: 397
• Watchers: 19
• Forks: 42
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This package is deprecated, as the Node now provides this functionality itself. This package exists only for historical purposes.

The node-promise project provides a complete promise implementation. Promises provide a clean separation

of concerns between asynchronous behavior and the interface so asynchronous

functions can be called without callbacks, and callback interaction can be 

done on the generic promise interface. The node-promise package provides just a promise implementation, however, https://github.com/kriszyp/promised-io is recommended for more complete promise-based IO functionality. The promised-io includes the promise implementation from node-promise, as well as wrappers around Node's filesystem and other system I/O APIs for consistent promise-based interaction.

The node-promise module features a promise implementation with:

* Chainable promises

* Promises throw errors if an error handler is not provided

* CommonJS promise proposal [1] compliant

* Immutable once fulfilled to reduce possible side-effects

* Promises can be used securely (as separate resolver/promise pairs in

ocap situations)

* Backwards compatibility where possible (addCallback, addErrback,

emitSuccess, and emitError should still behave as expected)

Utility functions, including:

* when() - Normalization of sync (normal values) and async (promises)

* all() - Create a promise that accumulate multiple concurrent promises (failed promises resolve to Error objects)

* allOrNone() - Ditto, but the first promise to fail causes the composition to fail as well

* first() - Find the first promise to be fulfilled in a group of promises

* seq() - Sequentially execute a set of promise returning functions

* delay() - Returns a promise that is fulfilled after a given amount of time

* execute() - Executes a function that takes a callback and returns a

promise (thank you Benjamin Thomas for providing this)

Much of this is adapted from Tyler Close's ref_send and Kris Kowal's work on promises. 

Some quick examples from test-promise.js (again, it is recommended that you use http://github.com/kriszyp/promised-io for file and other I/O interaction):

    util = require('util');

    var fs = require('./fs-promise');

    // open a file and read it

    fs.open("fs-promise.js", process.O_RDONLY).then(function(fd){

      return fs.read(fd, 4096);

    }).then(function(args){

      util.puts(args[0]); // print the contents of the file

    });

    // does the same thing

    fs.readFile("fs-promise.js").addCallback(util.puts);

A default Promise constructor can be used to create a self-resolving deferred/promise:

    var Promise = require("promise").Promise;

    var promise = new Promise();

    asyncOperation(function(){

      Promise.resolve("successful result");

    });

    promise -> given to the consumer

 

A consumer can use the promise:

    promise.then(function(result){

       ... when the action is complete this is executed ...

    },

    function(error){

        ... executed when the promise fails

    });

Alternately, a provider can create a deferred and resolve it when it completes an action. 

The deferred object a promise object that provides a separation of consumer and producer to protect

promises from being fulfilled by untrusted code.

    var defer = require("promise").defer;

    var deferred = defer();

    asyncOperation(function(){

      deferred.resolve("succesful result");

    });

    deferred.promise -> given to the consumer

 

Another way that a consumer can use promises:

    var when = require("promise").when;

    when(promise,function(result){

       ... when the action is complete this is executed ...

    },

    function(error){

       ... executed when the promise fails

    });

More examples:

    function printFirstAndList(itemsDeferred){

      findFirst(itemsDeferred).then(util.puts);

      findLast(itemsDeferred).then(util.puts);

    }

    function findFirst(itemsDeferred){

      return itemsDeferred.then(function(items){

        return items[0];

      });

    }

    function findLast(itemsDeferred){

      return itemsDeferred.then(function(items){

        return items[items.length];

      });

    }

And now you can do:

    printFirstAndLast(someAsyncFunction());

The workhorse function of this library is the "when" function, which provides a means for normalizing interaction with values and functions that may be a normal synchronous value, or may be a promise (asynchronously fulfilled). The when() function takes a value that may be a promise or a normal value for the first function, and when the value is ready executes the function provided as the second argument (immediately in the case of a non-promise normal value). The value returned from when() is the result of the execution of the provided function, and returns a promise if provided a promise or synchronously returns a normal value if provided a non-promise value. This makes it easy to "chain" computations together. This allows us to write code that is agnostic to sync/async interfaces:

    var when = require("promise").when;

    function printFirstAndLast(items){

      // print the first and last item

      when(findFirst(items), util.puts);

      when(findLast(items), util.puts);

    }

    function findFirst(items){

       // return the first item

       return when(items, function(items){

         return items[0];

       });

    }

    function findLast(items){

       // return the last item

       return when(items, function(items){

         return items[items.length - 1];

       });

    }

Now we can do:

    > printFirstAndLast([1,2,3,4,5]);

    1

    5

And we can also provide asynchronous promise:

    var promise = new process.Promise();

    > printFirstAndLast(promise);

(nothing printed yet)

    > promise.emitSuccess([2,4,6,8,10]);

    2

    10

The "all" function is intended to provide a means for waiting for the completion of an array of promises. The "all" function should be passed an array of promises, and it returns an promise that is fulfilled once all the promises in the array are fulfilled. The returned promise's resolved value will be an array with the resolved values of all of the promises in the passed in array.

The "first" function is intended to provide a means for waiting for the completion of the first promise in an array of promises to be fulfilled. The "first" function should be passed an array of promises, and it returns an promise that is fulfilled once the first promise in the array is fulfilled. The returned promise's resolved value will be the resolved value of the first fulfilled promise.