pr's Introduction

pr

node builtins wrapped for promises

all of node's builtin apis as Promises/A+ - returning functions. Use the core module APIs you know without the impedence mismatch of adapting them to promises yourself.

installation

$ npm install pr

usage

require any builtin module with pr/ before it

example

var fs = require('pr/fs')

fs.readdir(__dirname).then(function (files) {
  console.log(__dirname + ':\n' + files.join('\n'))
})

modules included

Methods taking one-time callbacks in the following module are wrapped with promise-returning versions:

Additionally, all base modules are available by require('pr/name') for convenience.

Functions which are documented as taking a callback, but which actually use the callback as an event listener rather than as a continuation, are not supported.

not currently implemented

(http|https).request and .get both take callbacks but also have return values of streams. These will be supported in a future release of pr, and the returned object will support both the stream and promise interface.

readline's Interface#question is not currently implemented.

We're interested in supporting the entire api! Please open a pull request to contribute.

api current as of node 0.8.x

contributors

jden [email protected]

license

Public Domain.

To the extent possible under law, Jason Denizac has waived all copyright and related or neighboring rights to pr. This work is published from: United States.

pr's People

Contributors

Stargazers

Watchers

pr's Issues

check out issue in fs/readFile

encoding: 'utf8' was still returning a buffer. sanity check myself.

fs.exists missing

Looks like fs.exists is missing from pr/fs.

Work with any Promise library

It would be nice if pr would work with any Promise library instead of using a bundled (outdated) bluebird.

This module prfun had a nice pattern where it either uses a local (polyfilled) ES6 Promise or user-supplied one:

var Promise = prfun(require('bluebird'));

Maybe this is interesting forpr too: this pattern saves a Promise.cast() around every call (it gets very tedious) and instead just use the same library as the rest of the user code.

Recommend Projects