extract-opts
Advanced tools
Extract the options and callback from a function's arguments easily
npm install --save extract-optsrequire('extract-opts')npm install --save extract-optsrequire('extract-opts')//wzrd.in/bundle/extract-opts@3.3.0ender add extract-optsrequire('extract-opts')This package is published with the following editions:
extract-opts aliases extract-opts/index.js which uses Editions to automatically select the correct edition for the consumers environmentextract-opts/source/index.js is Source + ESNext + Requireextract-opts/es2015/index.js is Babel Compiled + ES2015 + RequireOlder environments may need Babel's Polyfill or something similar.
var log = console.log.bind(console)
var extractOptsAndCallback = require('extract-opts')
// fs.readFile(filename, [options], callback)
function readFile (filename, opts, next) {
// Extract options and callback
var args = extractOptsAndCallback(opts, next)
opts = args[0]
next = args[1]
// Forward for simplicities sake
require('fs').readFile(filename, opts, next)
}
// Test it
readFile('package.json', log) // works with no options
readFile('package.json', null, log) // works with null options
readFile('package.json', {next: log}) // works with just options
Extract Options and Callback also supports a third argument.
You can use this third argument to customize the completionCallbackNames property that defaults to ['next'].
This is useful if your completion callback has other names besides next.
Allowing you to do the following:
var log = console.log.bind(console)
function extractOptsAndCallback (opts, next, config) {
if ( config == null ) config = {}
if ( config.completionCallbackNames == null ) config.completionCallbackNames = ['next', 'complete', 'done']
return require('extract-opts')(opts, next, config)
}
# The readFile method as before
# Test it
readFile('package.json', {next: log}) # works the standard completion callback name
readFile('package.json', {complete: log}) # works with our custom completion callback name
readFile('package.json', {done: log}) # works with our custom completion callback name
Discover the release history by heading on over to the HISTORY.md file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under:
v3.3.0 2016 May 27
FAQs
Extract the options and callback from a function's arguments easily
The npm package extract-opts receives a total of 113,422 weekly downloads. As such, extract-opts popularity was classified as popular.
We found that extract-opts demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.