https://github.com/calvinmetcalf/lie

A basic but performant promise implementation.
https://github.com/calvinmetcalf/lie

Last synced: about 2 months ago
JSON representation

A basic but performant promise implementation.

• Host: GitHub
• URL: https://github.com/calvinmetcalf/lie
• Owner: calvinmetcalf
• License: mit
• Created: 2013-08-16T13:24:23.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-08-21T14:09:23.000Z (about 4 years ago)
• Last Synced: 2024-07-18T14:05:44.871Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 366 KB
• Stars: 745
• Watchers: 16
• Forks: 67
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

• awesome - lie

README

        
# lie

[](https://promisesaplus.com)

[](https://travis-ci.org/calvinmetcalf/lie)

lie is a small, performant promise library implementing the [Promises/A+ spec](http://promises-aplus.github.com/promises-spec/) (Version 1.1).

Originally a fork of [Ruben Verborgh](https://github.com/RubenVerborgh)'s [promiscuous](https://github.com/RubenVerborgh/promiscuous), with version 2.6 it became a fork of [ayepromise](https://github.com/cburgmer/ayepromise) by [Chris Burgmer](https://github.com/cburgmer).

```bash

npm install lie

```

```javascript

var Promise = require('lie');

// or use the pollyfill

require('lie/polyfill');

```

## Usage

Either use it with [browserify](http://browserify.org/) (recommended) or grab one of the files from the dist folder:

- lie.js/lie.min.js exposes 'Promise' either as a UMD module or from the global scope, depending on if a CJS or AMD loader is available.

- lie.polyfill.js/lie.polyfill.min.js adds 'Promise' to the global scope only if it's not already defined (not a UMD).

## API

Implements the standard ES6 api:

```js

new Promise(function(resolve, reject){

    doSomething(function(err, result) {

        if (err) {

            reject(err);

        } else {

            resolve(result);

        }

    });

}).then(function (value) {

    //on success

}, function (reason) {

    //on error

}).catch(function (reason) {

    //shortcut for error handling

});

Promise.all([

    //array of promises or values

]).then(function ([/* array of results */]));

Promise.race([

    //array of promises or values

]);

// either resolves or rejects depending on the first value to do so

```

## Unhandled Rejections

In Node.js, lie emits an `unhandledRejection` event when a rejected promise isn't caught, in line with [how io.js does it](https://iojs.org/api/process.html#process_event_unhandledrejection). This allows it to act as a promise shim in both Node.js and the browser.