A library for simple promises and Deferred constructs with TypeScript support.
Go to file
2017-01-28 16:37:54 +01:00
dist add promisify 2017-01-28 16:37:54 +01:00
test add promisify 2017-01-28 16:37:54 +01:00
ts add promisify 2017-01-28 16:37:54 +01:00
.gitignore add ci 2016-12-16 21:21:58 +01:00
.gitlab-ci.yml add ci 2016-12-16 21:21:58 +01:00
package.json add promisify 2017-01-28 16:37:54 +01:00
README.md add promisify 2017-01-28 16:37:54 +01:00
tslint.json add ci 2016-12-16 21:21:58 +01:00

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 smartq does not repeat any native functions, so for things like .all() simply use Promise.all()

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

Dependency Credits:

who made what
notenoughneon typed-promisify

npm