params

params

Synopsis

var params = require('params');

#only

Remove everything, except the supplied keys.

params({ foo: 1, bar: 2, baz: 3 }).only('foo', 'baz');
params({ foo: 1, bar: 2, baz: 3 }).only(['foo', 'baz']);

// => { foo: 1, baz: 3 }

#except

Remove the supplied keys.

params({ foo: 1, bar: 2, baz: 3 }).except('foo', 'baz');
params({ foo: 1, bar: 2, baz: 3 }).except(['foo', 'baz']);

// => { bar: 2 }

#require

Require given keys

params({ foo: 1, bar: 2, baz: 3 }).require('missing', 'key');
params({ foo: 1, bar: 2, baz: 3 }).require(['missing', 'key']);

// Error: Missing key "missing" for { foo: 1, bar: 2, baz: 3 }

#permit/slice

Like #only, but mutates the object.

var hash = { foo: 1, bar: 2, baz: 3 };

params(hash)
  .permit('foo')
  .permit('baz')
  .slice()

console.log(hash);

// => { foo: 1, baz: 3 }

Installation

$ npm install params

Requirements

• Node.js >= 0.6.0

Tests

$ npm install
$ make test

License

(The MIT License)

Copyright (c) 2012 Veselin Todorov [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.