# promiscuous-umd

> A minimal and fast UMD-compatible promise implementation

Latest version **0.7.3** (published 2017-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install promiscuous-umd
pnpm add promiscuous-umd
yarn add promiscuous-umd
bun add promiscuous-umd
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.3 |
| Published | 2017-05-04 |
| First published | 2017-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Ruben Verborgh |
| Maintainers | mix3d |

## Links

- npm: https://www.npmjs.com/package/promiscuous-umd
- Repository: https://github.com/mix3d/promiscuous-umd
- Homepage: https://github.com/mix3d/promiscuous-umd#readme
- Issues: https://github.com/mix3d/promiscuous-umd/issues
- npm.io page: https://npm.io/package/promiscuous-umd

## Recent versions

- 0.7.3 (latest) — 2017-05-04
- 0.7.2 — 2017-05-04
- 0.7.1 — 2017-05-04

## README

# promiscuous-umd
<a href="http://promises-aplus.github.com/promises-spec">
  <img src="https://promisesaplus.com/assets/logo-small.png"
       alt="Promises/A+ logo" title="Promises/A+ 1.0 compliant" align="right" />
</a>

promiscuous-umd is a tiny-ish implementation of the [Promises/A+ spec](http://promises-aplus.github.com/promises-spec/).

It is promise library in JavaScript, **small** (< 1.5kb [minified](https://raw.github.com/mix3d/promiscuous-umd/dist/promiscuous-min.js) / < 0.75kb gzipped) and **fast**.

Forked from [promiscuous](http://github.com/mix3d/promiscuous-umd/), it trades an additional 0.5kb over the original library to provide a singular package compatible with all platforms and module loaders, including a shim to check if a native Promise is already provided, since it's 2017 and most browsers include them now.

## Installation and usage
### Node
First, install promiscuous with npm.
```bash
$ npm install promiscuous-umd
```

Then, include promiscuous in your code file.
```javascript
var Promise = require('promiscuous-umd');
```

### Browsers
Include in your HTML file, or via a your favorite module loader:
```html
<script src="promiscuous-umd.js"></script>
```
```javascript
//RequireJS
require( ['promiscuous-umd'],function (Promise) {
  var p = new Promise(function(resolve,reject){})
})
//CommonJS / Webpack
var Promise = require('promiscuous-umd');
```

A minified version is built on install (dist/promiscuous-min.js), but can be re-built with:
```bash
$ build/build.js
```

## API
### Create a resolved promise
```javascript
var promise = Promise.resolve("one");
promise.then(function (value) { console.log(value); });
/* one */
```

### Create a rejected promise
```javascript
var brokenPromise = Promise.reject(new Error("Could not keep promise."));
brokenPromise.then(null, function (error) { console.error(error.message); });
/* "Could not keep promise." */
```

You can also use the `catch` method if there is no success callback:

```javascript
brokenPromise.catch(function (error) { console.error(error.message); });
/* "Could not keep promise." */
```

### Write a function that returns a promise
```javascript
function promiseLater(something) {
  return new Promise(function (resolve, reject) {
    setTimeout(function () {
      if (something)
        resolve(something);
      else
        reject(new Error("nothing"));
    }, 1000);
  });
}
promiseLater("something").then(
  function (value) { console.log(value); },
  function (error) { console.error(error.message); });
/* something */

promiseLater(null).then(
  function (value) { console.log(value); },
  function (error) { console.error(error.message); });
/* nothing */
```

### Convert an array of promises into a promise for an array
```javascript
var promises = [promiseLater(1), promiseLater(2), promiseLater(3)];
Promise.all(promises).then(function (values) { console.log(values); });
/* [1, 2, 3] */
```

---
_Source: https://npm.io/package/promiscuous-umd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._