2018-07-03 06:39:25 +00:00
|
|
|
# @pushrocks/smartpromise
|
2018-03-16 09:24:12 +00:00
|
|
|
|
2018-07-03 06:39:25 +00:00
|
|
|
smart helpers that work with promises
|
2016-12-16 20:19:01 +00:00
|
|
|
|
|
|
|
|
## Availabililty
|
2018-03-16 09:24:12 +00:00
|
|
|
|
2017-02-12 11:56:22 +00:00
|
|
|
[](https://www.npmjs.com/package/smartq)
|
|
|
|
|
[](https://GitLab.com/pushrocks/smartq)
|
|
|
|
|
[](https://github.com/pushrocks/smartq)
|
|
|
|
|
[](https://pushrocks.gitlab.io/smartq/)
|
2016-12-16 20:19:01 +00:00
|
|
|
|
|
|
|
|
## Status for master
|
2018-03-16 09:24:12 +00:00
|
|
|
|
2016-12-16 20:19:01 +00:00
|
|
|
[](https://GitLab.com/pushrocks/smartq/commits/master)
|
|
|
|
|
[](https://GitLab.com/pushrocks/smartq/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/smartq)
|
|
|
|
|
[](https://david-dm.org/pushrocks/smartq)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartq/master/dependencies/npm)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartq)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
2017-07-06 12:55:42 +00:00
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
2016-12-16 20:19:01 +00:00
|
|
|
[](http://standardjs.com/)
|
|
|
|
|
|
|
|
|
|
## Usage
|
2018-03-16 09:24:12 +00:00
|
|
|
|
2016-12-16 20:19:01 +00:00
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
|
|
2017-01-20 20:58:53 +00:00
|
|
|
> Note: smartq uses native ES6 promises
|
2017-01-20 23:45:11 +00:00
|
|
|
> smartq does not repeat any native functions, so for things like .all() simply use Promise.all()
|
2017-01-20 20:58:53 +00:00
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
|
import * as q from 'smartq'
|
|
|
|
|
|
2017-01-28 15:37:54 +00:00
|
|
|
// Deferred
|
|
|
|
|
// -----------------------------------------------
|
2017-01-20 20:58:53 +00:00
|
|
|
let myAsyncFunction = (): Promise<string> => {
|
2017-01-20 21:01:10 +00:00
|
|
|
let done = q.defer<string>() // returns your typical Deferred object
|
2017-01-20 20:58:53 +00:00
|
|
|
setTimeout(() => {
|
2017-01-20 21:01:10 +00:00
|
|
|
done.resolve('hi') // will throw type error for other types than string as argument ;)
|
2017-01-20 20:58:53 +00:00
|
|
|
},6000)
|
|
|
|
|
return done.promise
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let myAsyncFunction2 = async () => {
|
|
|
|
|
let aString = await myAsyncFunction()
|
|
|
|
|
console.log(aString) // will log 'hi' to console
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
myAsyncFunction2();
|
|
|
|
|
|
2017-01-28 15:37:54 +00:00
|
|
|
|
|
|
|
|
// Resolved and Rejected promises
|
|
|
|
|
// ------------------------------------------------
|
2017-01-20 20:58:53 +00:00
|
|
|
q.resolvedPromise(`I'll get logged to console soon`)
|
|
|
|
|
.then(x => {
|
|
|
|
|
console.log(x)
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
q.rejectedPromise(`what a lovely error message`)
|
|
|
|
|
.then(() => {
|
|
|
|
|
console.log('This never makes it to console')
|
|
|
|
|
}/*, alternatively put a reject function here */)
|
|
|
|
|
.catch(err => {
|
|
|
|
|
console.log(err)
|
|
|
|
|
})
|
|
|
|
|
|
2017-01-28 15:37:54 +00:00
|
|
|
// Promisify (typed)
|
|
|
|
|
// ------------------------------------------------
|
|
|
|
|
|
|
|
|
|
let myCallbackedFunction = (someString: string, someNumber: number, cb) => {
|
|
|
|
|
cb(null, someString)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let myPromisedFunction = q.promisify(myCallbackFunction)
|
|
|
|
|
myPromisedFunction('helloThere', 2).then(x => {
|
|
|
|
|
console.log(x) // will log 'helloThere' to console
|
|
|
|
|
})
|
2017-01-20 20:58:53 +00:00
|
|
|
```
|
|
|
|
|
|
2017-02-12 11:56:22 +00:00
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
|
|
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
