json-pick-keys

Select keys from JSON Object for inclusion or exclusion.

Installation

$ npm install --save json-pick-keys

Usage

json-pick-keys helps you pick keys for inclusion and exclusion using space separated values. You can also rename and redact the keys.

Examples:

var pickKeys = require('json-pick-keys');

var obj = {
        a: 'Hello',
        b: 'World!',
        c: {
            name: "welcome",
            text : "Welcome To",
            font : { family : 'Open Sans', style: 'bold'}
        },
        d: ['is', 'json', 'pick', 'keys']
    };

You can then use the API like this:

pickKeys(obj, 'a b'); //  { a: 'Hello', b: 'World!'}
pickKeys(obj, 'c.name'); //   { c: { name: 'welcome' } }
pickKeys(obj, '-c'); //    { a: 'Hello', b: 'World!', d: [ 'is', 'json', 'pick', 'keys' ] }

Renaming keys

Use the pipe | symbol to rename your keys. And of-course this only works for inclusion. It would just silently fall through if used with exclusion.

pickKeys(obj, 'c.font.style|fontWeight d|array'); //  { c: { font: { fontWeight: 'bold' } }, array: [ 'is', 'json', 'pick', 'keys' ] }

Using Spread Operator with Renaming keys

Using the pipe | symbol to rename your key, you can also include other keys. This only works for inclusion and arrays are not supported. It would just silently fall through if used with an exclusion or array.

pickKeys(obj, '... c.font.style|fontWeight d|array'); //  {a: 'Hello', b: 'World!',  c: { font: { fontWeight: 'bold' } }, array: [ 'is', 'json', 'pick', 'keys' ] }

Redacting keys

Use the asterisk * symbol to redact your keys. You can also passing an option to change the redacted string, defaults to *****.

pickKeys(obj, 'a *b'); //  { a: 'Hello', b: '*****'}
pickKeys(obj, 'a *b', { redactString : '[REDACTED]'}); //  { a: 'Hello', b: '[REDACTED]'}

Using the Object Syntax

You can supply an object instead of a space separated values. This might come in handing for dynamic cases.

// for inclusion, these are equivalent
pickKeys(obj, 'a b'); //  { a: 'Hello', b: 'World!'}
pickKeys(obj, {a : 1, b : 1}); //  { a: 'Hello', b: 'World!'}


// for exclusion, these are equivalent
pickKeys(obj, '-c'); //    { a: 'Hello', b: 'World!', d: [ 'is', 'json', 'pick', 'keys' ] }
pickKeys(obj, {c : 0}); //    { a: 'Hello', b: 'World!', d: [ 'is', 'json', 'pick', 'keys' ] }


// for renaming, these are equivalent
pickKeys(obj, 'c.font.style|fontWeight'); //  { c: { font: { fontWeight: 'bold' } } }
pickKeys(obj, {'c.font.style|fontWeight' : 1}); //  { c: { font: { fontWeight: 'bold' } } }


// for redacting, these are equivalent
pickKeys(obj, 'a *b'); //   { a: 'Hello', b: '*****'}
pickKeys(obj, {'a' : 1, `b` : 2}); //   { a: 'Hello', b: '*****'}

Having Data as array

json-pick-keys works the same for arrays, so chill, no need to worry.

var arr = [{
        a: 'Hello',
        b: 'World!',
        c: {
            name: "welcome",
            text : "Welcome To",
            font : { family : 'Open Sans', style: 'bold'}
        },
        d: ['is', 'json', 'pick', 'keys']
    }];

pickKeys(arr, 'a b'); //  [{ a: 'Hello', b: 'World!'}]

Note

Don't use inclusion and exclusion together, but really, why would you wanna do that?

However if you must do it, make sure that any nested key you want to exclude you include it first. Check this example:

pickKeys(obj, 'a b c -c.font'); //  { a: 'Hello', b: 'World!', c: { name: 'welcome', text: 'Welcome To' } }

If you don't include the c first then, automatically c would be excluded

License

License under the MIT License (MIT)

Copyright (c) 2018 Olurin O. Oreofe

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.