Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lxsmnsyc/px
Extension functions for JS Promise
https://github.com/lxsmnsyc/px
defer deferred deferred-promise promise promise-api promise-library promises promises-aplus
Last synced: 1 day ago
JSON representation
Extension functions for JS Promise
- Host: GitHub
- URL: https://github.com/lxsmnsyc/px
- Owner: lxsmnsyc
- License: mit
- Created: 2019-03-05T06:14:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-03-12T03:36:45.000Z (over 5 years ago)
- Last Synced: 2024-11-08T18:48:42.385Z (4 days ago)
- Topics: defer, deferred, deferred-promise, promise, promise-api, promise-library, promises, promises-aplus
- Language: JavaScript
- Homepage: https://lxsmnsyc.github.io/px/
- Size: 510 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Px
Extension functions for JS Promise
[](https://www.npmjs.com/package/promise-ex)
[](https://www.jsdelivr.com/package/npm/promise-ex)
[](http://hits.dwyl.io/lxsmnsyc/Px)
| Platform | Build Status |
| --- | --- |
| Linux | [](https://travis-ci.org/LXSMNSYC/Px) |
| Windows | [](https://ci.appveyor.com/project/LXSMNSYC/px) |
[](https://codecov.io/gh/LXSMNSYC/Px)
[](https://david-dm.org/lxsmnsyc/px?type=dev)
[](http://inch-ci.org/github/lxsmnsyc/px)
## Introduction
Px allows the extension of the native Promise objects by adding additional functions to its prototype.
Px also introduces two Promise variants:
* DeferredPromise which is a Promise that, unlike a vanilla Promise, does not call the executor passed to its constructor synchronously but calls it whenever a callback is attached to it (so it produces a different Promise objects every call).
* PublishedPromise, which allows asynchronous fulfillment.
## Install
NPM
```bash
npm i promise-ex
```
then in NodeJs:
```js
let Px = require('promise-ex');
```
CDN
```html
```
## Example
Working example can be found at [RunKit](https://runkit.com/lxsmnsyc/5c7f46ce7310350012d0860c).
## Changelogs
* 0.3.6
* Fixed delayedReject only resolving.
* 0.3.5
* AirBnb style
* 0.3.0
* Promise.test
* Fix on comments
* Fixed DeferredPromise.delay only resolving
* 0.2.0
* Delayed Resolve and Reject
* 0.1.0
* Initial Release
## Build
First, run install the dependencies:
```bash
npm install
```
Run the test suite
```bash
npm test
```
You can also try generating the docs
```bash
npm run generate-docs
```
## License
MIT License
Copyright (c) 2019 Alexis Munsayac
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.