Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

bluebird2

overlookmotel41MIT3.0.1

bluebird v2.x

bluebird

readme

bluebird2.js

bluebird v2.x

Current status

NPM version Build Status Dependency Status Dev dependency Status Coverage Status

Usage

Exports bluebird Promise library v2.x.

Why on earth would you use this rather than bluebird itself? Well you probably wouldn't, and shouldn't.

Only reason is along with bluebird3 if you need to load both versions v2.x and v3.x of bluebird simultaneously, for example for running tests on a module which should work with either version.

var Bluebird2 = require('bluebird2');
var Bluebird3 = require('bluebird3');
// Now you have both. Whoopee!

Bluebird.getNewLibraryCopy()

This module adds one method to the Bluebird constructor if not present already: .getNewLibraryCopy()

.getNewLibraryCopy() returns a new independent instance of the Bluebird library.

var Bluebird = require('bluebird2');
var BluebirdX = Bluebird.getNewLibraryCopy();

console.log(BluebirdX != Bluebird); // true

Bluebird.version

The module adds .version property to the Bluebird constructor, containing the semver version of Bluebird.

var Bluebird = require('bluebird2');
console.log(Bluebird.version); // e.g. '2.10.2'

Tests

Use npm test to run the tests. Use npm run cover to check coverage.

Changelog

See changelog.md

Issues

If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/bluebird2/issues

Contribution

Pull requests are very welcome. Please:

  • ensure all tests pass before submitting PR
  • add an entry to changelog
  • add tests for new features
  • document new functionality/API additions in README

changelog

Changelog

1.0.0

  • Initial release

1.1.0

  • Erroneous release - no changes

1.1.1

  • clone method

1.2.0

  • version property
  • README typo

2.0.0

  • Return independent instance of bluebird
  • Update dev dependencies
  • Replace Makefile with npm scripts
  • Travis tests against node v6

2.1.0

  • .getNewLibraryCopy() method (was .clone())

3.0.0

  • Remove .clone() method
  • Pin bluebird dependency to trigger a PR from greenkeeper whenever new version released
  • Travis CI runs on all branches (to allow greenkeeper to trigger Travis)
  • Travis CI does not run on tags
  • Tidy npm scripts
  • Update dev dependencies

3.0.1

  • Update bluebird to v2.11.0