Extract the options and callback from a function's arguments easily
JavaScript
Latest commit 87e349b May 27, 2016 @balupton balupton v3.3.1. Improvement.
Permalink
Failed to load latest commit information.
source
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
index.js
package.json

README.md

Extract Options & Callback

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Slack community badge Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Extract the options and callback from a function's arguments easily

Install

NPM

  • Install: npm install --save extract-opts
  • Module: require('extract-opts')

Browserify

  • Install: npm install --save extract-opts
  • Module: require('extract-opts')
  • CDN URL: //wzrd.in/bundle/extract-opts@3.3.1

Ender

  • Install: ender add extract-opts
  • Module: require('extract-opts')

Editions

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 environment
  • extract-opts/source/index.js is Source + ESNext + Require
  • extract-opts/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

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

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:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

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: