is-options

Easily check if input is an options map

npm install is-options

Usage

var isOptions = require('is-options')

thing('', {foo: true}) // key='', opts={foo: true}
thing({foo: true}) // key=undefined, opts={foo: true}
thing(Buffer.from('buf'), {foo: true}) // key=Buffer('buf'), opts={foo: true}

function thing (optionalKey, opts) {
  if (isOptions(optionalKey)) {
    opts = optionalKey
    optionalKey = undefined
  }

  console.log('key', optionalKey)
  console.log('options', opts)
}

API

bool = isOptions(obj)

Returns true is obj is an object and not a buffer

License

MIT

Current Tags

• 1.0.2                                ...           latest (3 years ago)

3 Versions

• 1.0.2                                ...           3 years ago
• 1.0.1                                ...           7 years ago
• 1.0.0                                ...           7 years ago