1.0.0 • Published 9 years ago

wrap-sync v1.0.0

Weekly downloads
27
License
MIT
Repository
github
Last release
9 years ago

wrapSync

Last version Build Status Dependency status Dev Dependencies Status NPM Status Donate

Take a sync function and make it async, passing its return value to a callback. Based on async#asyncify as module.

Install

npm install wrapsync --save

If you want to use in the browser (powered by Browserify):

bower install wrapsync --save

and later link in your HTML:

<script src="bower_components/wrapsync/dist/wrapsync.js"></script>

Usage

var wrapSync = require('wrapsync');

var parse = wrapSync(JSON.parse);

parse('{\"foo\":bar}', function(err, result) {
  // data is the result of parsing the text.
  // If there was a parsing error, it would have been caught.
});

API

wrapSync(fn)

Take a sync function and make it async, passing its return value to a callback. This is useful for plugging sync functions into a waterfall, series, or other async functions. Any arguments passed to the generated function will be passed to the wrapped function (except for the final callback argument). Errors thrown will be passed to the callback

Arguments

  • fn - a sync function.

License

MIT © Kiko Beats