Skip to content

Latest commit

 

History

History
196 lines (138 loc) · 7.44 KB

.verb.md

File metadata and controls

196 lines (138 loc) · 7.44 KB
Raw

{%= name %} {%= badge('npm') %} [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

{%= description %}

[![code climate][codeclimate-img]][codeclimate-url] code style [![linux build][travis-img]][travis-url] [![windows build][appveyor-img]][appveyor-url] [![code coverage][coverage-img]][coverage-url] [![dependency status][david-img]][david-url] paypal donate

Pretty much like [any-promise][], but works a bit different & better.

Let your library support any ES 2015 (ES6) compatible Promise and leave the choice to application authors. The application can optionally register its preferred Promise implementation and it will be exported when requiring any-promise from library code. –– [any-promise][]

If no preference is registered, always defaults to native Promise, using [native-promise][] detection. It defaults to global Promise for newer Node.js >= 0.12 versions. The browser version defaults to the window Promise, so polyfill or register as necessary.

Table of Contents

Install

Install with npm

$ npm install {%= name %} --save

or install using yarn

$ yarn add {%= name %}

Usage

For more use-cases see the tests.

Examples assumes that they are ran in older node versions, meaning < 0.12, be aware of that!

Get a Promise, always

Use it as any other Promise. It will give you native Promise always, until node < 0.12 - in that case it will try to load one of the common promise libraries, otherwise it will throw with a useful message to signal your users to install some of these promise implementations or register other one.

const Promise = require('{%= name %}')

const promise = new Promise((resolve, reject) => {
  resolve(123)
})

promise.then((res) => console.log('foo:', res))

Custom Promise registration

You can .register() a custom Promise which will be used by the main export. That function also returns that Promise. If no arguments are passed, it will try to load some of the common promise libraries, again.

const register = require('native-or-another/register')

const MyCustomPromise = () => 444
register({ Promise: MyCustomPromise })

const Promize = require('native-or-another')

// loads `MyCustomPromise`
const res = Promize()
console.log(res) // => 444

// but also adds it to global scope
const res = Promise()
console.log(res) // => 444

// but also adds it to global.Promise
const res = global.Promise()
console.log(res) // => 444

Notice that it adds the promise to global scope and global, if you don't want that behaviour you should disable it through passing an option to .register function, like { global: false }.

const register = require('native-or-another/register')
const Promize = register({ global: false })

console.log(Promize) // => function
console.log(Promise) // => undefined
console.log(global.Promise) // => undefined

This is exactly how require('native-or-another') works!

Support for old Node.js versions

Node.js versions prior to v0.12 may have contained buggy versions of the global Promise. For this reason, the global Promise is not loaded automatically for these old versions.
If using native-or-another in Node.js versions < v0.12, the user should register a desired implementation.

If an implementation is not registered, native-or-another will attempt to discover an installed Promise implementation. If no implementation can be found, an error will be thrown on require('native-or-another'). While the auto-discovery usually avoids errors, it is non-deterministic. It is recommended that the user always register a preferred implementation for older Node.js versions.

This auto-discovery is only available for Node.js versions before v0.12. Any newer versions (includeing v0.12) will always default to the global Promise implementation.

Adapted from the [any-promise][] readme.

{% if (verb.related && verb.related.list && verb.related.list.length) { %}

Related

{%= related(verb.related.list, {words: 17}) %} {% } %}

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

  1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
  2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
  3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
  4. Do NOT bump the version in package.json. For that we use npm run release, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

{%= includeEither('authors', 'author') %}

License

{%= copyright({ start: 2014, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %}

{%= include('footer') %}
Project scaffolded using [charlike][] cli.

{%= reflinks(verb.reflinks) %}

[license-url]: https://www.npmjs.com/package/{%= name %} [license-img]: https://img.shields.io/npm/l/{%= name %}.svg

[downloads-url]: https://www.npmjs.com/package/{%= name %} [downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg

[codeclimate-url]: https://codeclimate.com/github/{%= repository %} [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg

[travis-url]: https://travis-ci.org/{%= repository %} [travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %} [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows

[coverage-url]: https://codecov.io/gh/{%= repository %} [coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg

[david-url]: https://david-dm.org/{%= repository %} [david-img]: https://img.shields.io/david/{%= repository %}.svg