extract-opts v5.9.0
Extract the options and callback from a function's arguments easily
npm
jspm
<script type="module">
import * as pkg from '//dev.jspm.io/extract-opts'
</script>
Usage
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
Customisation
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:
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
8 years ago
8 years ago
8 years ago
8 years ago
9 years ago
9 years ago
11 years ago
11 years ago