Sha256: da13f5b097e3bdf3d8b011b4edfaa7202bb9d7272c0e7d70c4341d0e1cefa841

Contents?: true

Size: 1.96 KB

Versions: 49

Compression:

Stored size: 1.96 KB

Contents

# universalify

[![Travis branch](https://img.shields.io/travis/RyanZim/universalify/master.svg)](https://travis-ci.org/RyanZim/universalify)
![Coveralls github branch](https://img.shields.io/coveralls/github/RyanZim/universalify/master.svg)
![npm](https://img.shields.io/npm/dm/universalify.svg)
![npm](https://img.shields.io/npm/l/universalify.svg)

Make a callback- or promise-based function support both promises and callbacks.

Uses the native promise implementation.

## Installation

```bash
npm install universalify
```

## API

### `universalify.fromCallback(fn)`

Takes a callback-based function to universalify, and returns the universalified  function.

Function must take a callback as the last parameter that will be called with the signature `(error, result)`. `universalify` does not support calling the callback with three or more arguments, and does not ensure that the callback is only called once.

```js
function callbackFn (n, cb) {
  setTimeout(() => cb(null, n), 15)
}

const fn = universalify.fromCallback(callbackFn)

// Works with Promises:
fn('Hello World!')
.then(result => console.log(result)) // -> Hello World!
.catch(error => console.error(error))

// Works with Callbacks:
fn('Hi!', (error, result) => {
  if (error) return console.error(error)
  console.log(result)
  // -> Hi!
})
```

### `universalify.fromPromise(fn)`

Takes a promise-based function to universalify, and returns the universalified  function.

Function must return a valid JS promise. `universalify` does not ensure that a valid promise is returned.

```js
function promiseFn (n) {
  return new Promise(resolve => {
    setTimeout(() => resolve(n), 15)
  })
}

const fn = universalify.fromPromise(promiseFn)

// Works with Promises:
fn('Hello World!')
.then(result => console.log(result)) // -> Hello World!
.catch(error => console.error(error))

// Works with Callbacks:
fn('Hi!', (error, result) => {
  if (error) return console.error(error)
  console.log(result)
  // -> Hi!
})
```

## License

MIT

Version data entries

49 entries across 49 versions & 3 rubygems

Version Path
clapton-0.0.26 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.25 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.24 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.23 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.22 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.21 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.20 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.19 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.18 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.17 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.16 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.15 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.14 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.13 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.12 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.11 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.10 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.9 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.8 lib/clapton/javascripts/node_modules/universalify/README.md
clapton-0.0.7 lib/clapton/javascripts/node_modules/universalify/README.md