README
dush-promise
Plugin for
dush
that makes it a Deferred promise and adds.resolve
,.reject
,.than
and.catch
methods for more better error handling experience
You might also be interested in dush.
Quality 👌
By using commitizen and conventional commit messages, maintaining meaningful ChangeLog and commit history based on global conventions, following StandardJS code style through ESLint and having always up-to-date dependencies through integrations like GreenKeeper and David-DM service, this package has top quality.
Stability 💯
By following Semantic Versioning through standard-version releasing tool, this package is very stable and its tests are passing both on Windows (AppVeyor) and Linux (CircleCI) with results from 100% to 400% test coverage, reported respectively by CodeCov and nyc (istanbul).
Support :clap:
If you have any problems, consider opening an issue, ping me on twitter (@tunnckoCore), join the support chat room or queue a live session on CodeMentor with me. If you don't have any problems, you're using it somewhere or you just enjoy this product, then please consider donating some cash at PayPal, since this is OPEN Open Source project made with love at Sofia, Bulgaria 🇧🇬.
Table of Contents
(TOC generated by verb using markdown-toc)
Install
Install with npm
$ npm install dush-promise --save
or install using yarn
$ yarn add dush-promise
Usage
For more use-cases see the tests
const dushPromise = require('dush-promise')
API
dushPromise
Adds a Promise methods such as
.resolve
,.reject
.then
and.catch
to your dush application. Useful from inside plugins. This plugin also emitserror
event whenapp.reject
is used.
Params
opts
{Object}: optional, passed directly to native-promise-deferredreturns
{Function}: a plugin function that should be passed to.use
method of dush
Example
var dush = require('dush')
var promise = require('dush-promise')
var app = dush().use(promise())
console.log(app.then)
console.log(app.catch)
console.log(app.reject)
console.log(app.resolve)
.then
Handle resolved promise with
onresolved
or rejected promise withonrejected
. It is as any usual Promise.then
method.
Params
onresolved
{Function}onrejected
{Function}returns
{Promise}
Example
app.then((res) => {
console.log(res) // => 123
})
app.resolve(123)
// or handle rejected promise
app.then(null, (er) => {
console.log('err!', er) // => Error: foo bar
})
app.reject(new Error('foo bar'))
.catch
Catch a rejected promise error. This method is mirror of any usual promise
.catch
method.
Params
onrejected
{Function}returns
{Promise}
Example
app.on('error', (err) => {
console.log('er!', err) // => Error: sad err
})
app.catch((err) => {
console.log('oops, error!', err) // => Error: sad err
})
app.reject(new Error('sad err'))
.resolve
As any usual
Promise.resolve
method.
Params
val
{any}returns
{Promise}
Example
app.use((app) => {
app.foo = () => {
return app.resolve(1222)
}
})
const promise = app.foo()
promise.then((val) => {
console.log('res:', val) // => 1222
})
.reject
As any usual
Promise.reject
method.
Params
err
{Error}returns
{Promise}
Example
app.on('error', (err) => {
console.log('some error:', err) // => Error: quxie
})
app.reject(new Error('quxie'))
Related
- dush-methods: Plugin for
dush
and anything based on it. It adds helper.define
and.delegate
methods | homepage - dush-no-chaining: A plugin that removes the emitter methods chaining support for
dush
,base
,minibase
or anything based on them | homepage - dush-options: Adds
.option
,.enable
and.disable
methods to yourdush
application | homepage - dush-router: A simple regex-based router for
dush
,base
,minibase
and anything based on them. Works on Browser and Node.js | homepage - dush-tap-report: A simple TAP report producer based on event system. A plugin for
dush
event emitter or anything based on it | homepage - dush: Microscopic & functional event emitter in ~260 bytes, extensible through plugins. | homepage
- minibase-create-plugin: Utility for minibase and base that helps you create plugins | homepage
- minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
- native-or-another: Guaranteed way for getting a Promise. Always native Promise if available, otherwise looks for common promise libraries and loads which… more | homepage
- native-promise-deferred: A deferred Promise, using
native-or-another
behind and so it work on Node.js v0.10 too! | homepage - native-promise: Get native
Promise
or falsey value if not available. | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.
In short: If you want to contribute to that project, please follow these things
- Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
- Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
- Always use
npm run commit
to commit changes instead ofgit commit
, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy. - Do NOT bump the version in package.json. For that we use
npm run release
, which is standard-version and follows Conventional Changelog idealogy.
Thanks a lot! :)
Building docs
Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb
command like that
$ npm install verbose/verb#dev verb-generate-readme --global && verb
Please don't edit the README directly. Any changes to the readme must be made in .verb.md.
Running tests
Clone repository and run the following in that cloned directory
$ npm install && npm test
Author
Charlike Mike Reagent
License
Copyright © 2017, Charlike Mike Reagent. Released under the MIT License.
This file was generated by verb-generate-readme, v0.4.3, on April 02, 2017.
Project scaffolded using charlike cli.