Extract the options and callback from a function's arguments easily
Install
- Install:
npm install --save extract-opts
- Use:
require('extract-opts')
- Install:
npm install --save extract-opts
- Use:
require('extract-opts')
- CDN URL:
//wzrd.in/bundle/extract-opts@3.1.0
- Install:
ender add extract-opts
- Use:
require('extract-opts')
Usage
JavaScript
var extractOptsAndCallback = require('extract-opts')
var log = console.log.bind(console)
var readFile = function(filename, opts, next){
var args = extractOptsAndCallback(opts, next)
opts = args[0]
next = args[1]
require('fs').readFile(filename, opts, next)
}
readFile('package.json', log)
readFile('package.json', null, log)
readFile('package.json', {next:log})
CoffeeScript
extractOptsAndCallback = require('extract-opts')
log = console.log.bind(console)
# fs.readFile(filename, [options], callback)
readFile = (filename, opts, next) ->
# Extract options and callback
[opts, next] = extractOptsAndCallback(opts, next)
# 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
Configuration
Extract Options and Callback also supports a third argument for custom configuration
.
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:
extractOptsAndCallback = (opts, next, config={}) ->
config.completionCallbackNames ?= ['next', 'complete', 'done']
return require('extract-opts')(opts, next, config)
log = console.log.bind(console)
# 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 compeltion callback name
readFile('package.json', {done:log}) # works with our custom compeltion callback name
History
Discover the release history by heading on over to the HISTORY.md
file.
Contribute
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Backers
Maintainers
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
License
Unless stated otherwise all works are:
and licensed under: