Awesome
<p align="center"> <a href="https://github.com/hybridables"> <img height="250" width="250" src="https://avatars1.githubusercontent.com/u/10666022?v=3&s=250"> </a> </p>try-catch-callback
try/catch block with a callback, used in try-catch-core. Use it when you don't care about asyncness so much and don't want guarantees. If you care use try-catch-core.
Install
npm i try-catch-callback --save
Usage
For more use-cases see the tests
const tryCatchCallback = require('try-catch-callback')
tryCatchCallback
Pass a synchronous
fn
that returns some result and handle completion or errors incb
if given, otherwise it returns thunk which accepts thatcb
. It's possible to not work in "async mode", if that's the case try to use try-catch-core for your case, which guarantees thatcb
is called only once and always in next tick, using dezalgo and once.
Params
<fn>
{Function}: function to be called.[opts]
{Object}: optional options, such ascontext
andargs
[opts.context]
{Object}: context to be passed tofn
[opts.args]
{Array}: custom argument(s) to be pass tofn
, given value is arrayified[opts.passCallback]
{Boolean}: passtrue
if you wantcb
to be passed tofn
args[opts.return]
{Boolean}: iftrue
returns error/value and does not callscb
[cb]
{Function}: callback withcb(err, res)
signature.returns
{Function}thunk
: ifcb
not given.
Example
var tryCatch = require('try-catch-callback')
tryCatch(function () {
return 'fox qux'
}, function done (err, res) {
if (err) return console.error(err)
console.log(res) // => 'fox qux'
})
passing custom context
const tryCatch = require('try-catch-callback')
tryCatch(function () {
console.log(this.foo) // => 'bar'
console.log(this.baz) // => 'qux'
return `${this.foo}/${this.baz}`
}, {
context: { foo: 'bar', baz: 'qux' }
}, function done (err, res) {
if (err) return console.error(err)
console.log(res) // => 'bar/qux'
})
passing custom arguments
const tryCatchCallback = require('try-catch-callback')
const done = (err, res) => console.log(res) // => 'zzz123'
const opts = {
args: [ { foo: 'zzz' }, 123 ]
}
tryCatchCallback((ctx, qux) => {
return ctx.foo + qux
}, opts, done)
returning a thunk
const tryCatch = require('try-catch-callback')
const thunk = tryCatch((a, b) => {
return a + b + 3
}, { args: [1, 2] })
thunk((err, res) => {
console.log(res) // => 6
})
Related
- catchup: Graceful error handling. Because core
domain
module is deprecated. This share almost the same API. | homepage - gana-compile: Pretty small synchronous template engine built on ES2015 Template Strings, working on
node@0.10
too. No RegExps, support for helpers and… more | homepage - gana: Small and powerful template engine with only sync and async compile. The mid-level between es6-template and gana-compile. | homepage
- try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and dezalgo libs. Useful for and… more | homepage
- try-require-please: Try to require the given module, failing loudly with default message if module does not exists. | 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 © 2016-2017, Charlike Mike Reagent. MIT
This file was generated by verb-generate-readme, v0.4.2, on March 01, 2017.
Project scaffolded using charlike cli.