Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitaly-t/spex
:bulb: Specialized Promise Extensions
https://github.com/vitaly-t/spex
promise-library promise-wrapper promises
Last synced: 6 days ago
JSON representation
:bulb: Specialized Promise Extensions
- Host: GitHub
- URL: https://github.com/vitaly-t/spex
- Owner: vitaly-t
- License: mit
- Created: 2015-09-14T00:37:28.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T22:44:39.000Z (about 1 month ago)
- Last Synced: 2024-12-01T05:08:07.067Z (13 days ago)
- Topics: promise-library, promise-wrapper, promises
- Language: JavaScript
- Homepage: http://vitaly-t.github.io/spex
- Size: 1.21 MB
- Stars: 52
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SPEX
----
Specialized Promise Extensions.
[](https://github.com/vitaly-t/spex/actions/workflows/ci.yml)
[](https://nodejs.org)
[batch], [page], [sequence] - promise methods for the following patterns:
* [Data Throttling & Load Balancing](http://vitaly-t.github.io/spex/tutorial-throttling.html)
* [Linked and Detached Sequencing](http://vitaly-t.github.io/spex/tutorial-sequencing.html)
* [Streaming and Paging](http://vitaly-t.github.io/spex/tutorial-streaming.html)
* [Batch Processing](http://vitaly-t.github.io/spex/tutorial-batch.html)
## Installing
```
$ npm i spex
```
## Usage
* For any [Promises/A+] library: [Promise], [Bluebird], [When], [Q], [RSVP], etc.
```js
const promise = require('bluebird');
const spex = require('spex')(promise);
```
* For ES6 Promise:
```js
const spex = require('spex')(Promise);
```
See also: [client-side usage](http://vitaly-t.github.io/spex/tutorial-client.html).
## API
* [Module]
* Methods
- [batch]
- [page]
- [sequence]
- [stream](http://vitaly-t.github.io/spex/stream.html)
- [read]
## Testing
* Clone the repository (or download, if you prefer):
```
$ git clone https://github.com/vitaly-t/spex
```
* Install the library's DEV dependencies:
```
$ npm install
```
* To run all tests:
```
$ npm test
```
* To run all tests with coverage:
```
$ npm run coverage
```
## License
Copyright © 2020 [Vitaly Tomilov](https://github.com/vitaly-t);
Released under the MIT license.
[Module]:http://vitaly-t.github.io/spex/index.html
[batch]:http://vitaly-t.github.io/spex/global.html#batch
[page]:http://vitaly-t.github.io/spex/global.html#page
[sequence]:http://vitaly-t.github.io/spex/global.html#sequence
[read]:http://vitaly-t.github.io/spex/stream.html#.read
[Promises/A+]:https://promisesaplus.com/
[Promise]:https://github.com/then/promise
[Bluebird]:https://github.com/petkaantonov/bluebird
[When]:https://github.com/cujojs/when
[Q]:https://github.com/kriskowal/q
[RSVP]:https://github.com/tildeio/rsvp.js