smartq
Version:
dropin replacement for q
85 lines (63 loc) • 3.36 kB
Markdown
# smartq
dropin replacement for q
## Availabililty
[](https://www.npmjs.com/package/smartq)
[](https://GitLab.com/pushrocks/smartq)
[](https://github.com/pushrocks/smartq)
[](https://pushrocks.gitlab.io/smartq/)
## Status for master
[](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/)
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
[](http://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
> Note: smartq uses native ES6 promises
> smartq does not repeat any native functions, so for things like .all() simply use Promise.all()
```javascript
import * as q from 'smartq'
// Deferred
// -----------------------------------------------
let myAsyncFunction = (): Promise<string> => {
let done = q.defer<string>() // returns your typical Deferred object
setTimeout(() => {
done.resolve('hi') // will throw type error for other types than string as argument ;)
},6000)
return done.promise
}
let myAsyncFunction2 = async () => {
let aString = await myAsyncFunction()
console.log(aString) // will log 'hi' to console
}
myAsyncFunction2();
// Resolved and Rejected promises
// ------------------------------------------------
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)
})
// 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
})
```
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
[](https://push.rocks)