pushrocks/smartpromise


simple promises and Deferred constructs | https://push.rocks | made by [Lossless](https://lossless.com)

http://html5media.info/

License: GPL-3.0

Language: JavaScript


@pushrocks/smartpromise

simple promises and Deferred constructs

Availabililty and Links

Status for master

build status coverage report npm downloads per month Known Vulnerabilities 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 '@pushrocks/smartpromise'

// 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 | By using this npm module you agree to our privacy policy

repo-footer

Project Statistics

Sourcerank 9
Repository Size 57.8 MB
Stars 0
Forks 0
Watchers 0
Open issues 1
Dependencies 104
Tags 22
Created
Last updated

Packages Referencing this Repo

smartq
dropin replacement for q
Latest release 1.1.8 - Updated

Recent Tags See all

v3.0.2 March 26, 2019
v3.0.1 March 26, 2019
v3.0.0 March 26, 2019
v2.0.5 July 03, 2018
v2.0.4 July 03, 2018
v2.0.3 July 02, 2018
v2.0.2 July 02, 2018
v2.0.1 July 02, 2018
v2.0.0 July 02, 2018
v1.1.8 March 16, 2018
v1.1.7 July 27, 2017
v1.1.6 July 06, 2017
v1.1.5 July 06, 2017
v1.1.4 July 06, 2017
v1.1.3 July 06, 2017

Something wrong with this page? Make a suggestion

Last synced: 2019-09-06 08:01:53 UTC

Login to resync this repository