This package has been deprecated

Author message:

smartq has been deprecated in favour of @pushrocks/smartpromise - please upgrade asap!!!

smartq
TypeScript icon, indicating that this package has built-in type declarations

1.1.8 • Public • Published

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

For further information read the linked docs at the top of this README.

MIT licensed | © Lossless GmbH

repo-footer

Readme

Keywords

none

Package Sidebar

Install

npm i smartq

Weekly Downloads

163

Version

1.1.8

License

MIT

Unpacked Size

21.1 kB

Total Files

10

Last publish

Collaborators

  • lossless