smartpromise/README.md
2017-01-20 22:01:10 +01:00

2.8 KiB

smartq

dropin replacement for q

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

Note: smartq uses native ES6 promises

import * as q from 'smartq'

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();
q.all(myAsyncFunction(), myAsyncFunction2())
    .then(() => {
        console.log('all promises for q.all have been fullfilled')
    })

q.race(/* some promises here */)
    .then(() => {
        console.log('at least one promise for q.race is fullfilled')
    })

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)
    })

npm