wo

whitelist-object

a small module for reducing an object to only the desired keys

Showing:

Popularity

Downloads/wk

69

GitHub Stars

3

Maintenance

Last Commit

4yrs ago

Contributors

1

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

White List Object

Build Status

A small module that takes in an object and returns a new object only containing white listed keys.

Args

  • object - the object you want to reduce to only whitelisted keys.
  • whitelist - an array containing the keys you want the new object to maintain
  • shallow - optional true false value. if true, will only look for whitelisted keys in top level object. defaults to false.

Install

npm i whitelist-object --save

Example

var whiteListObject = require("whitelist-object");

var myObject = {
    cool: "guy",
    conor: "hastings",
    wow: "so cool",
    but: {is: "he", no: "he isn't"}
};
var whiteListedObject = whiteListObject(myObject, ["cool", "but", "is"], false);
//returns {cool: "guy", but: {is: "he"}};
var shallowWhiteListObject = whiteListObject(myObject, ["cool", "but", "is"], true);
//returns {cool: "guy", but: {is: "he", no: "he isn't"}};

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial