subobject v0.1.0

Subobject - pick a subset of keys from an object

Installation

$ npm install --save subobject

Usage

import { subobject } from 'subobject';

// An example object
const user = {
    id: 123,
    firstName: 'Bob',
    otherNames: 'Smith',
    role: {
        name: 'Admin',
        permissions: [
            {id: 1, 'CAN_CREATE_WIDGETS'},
            {id: 2, 'CAN_DELETE_WIDGETS'},
        ]
    }
};

const pickNames = subobject('{firstName, otherNames}');

console.log(pickNames(user));
//{
//    firstName: 'Bob',
//    otherNames: 'Smith'
//}

const idAndRoleName = subojbect('{id, role: { name }}');

console.log(idAndRole(user));
//{
//    id: 123,
//    role: {
//        name: 'Admin'
//    }
//}

const rolePermissions = subobject('{role: { name, permissions: { id }}}');

// For arrays, the filter is applied to each item
console.log(roleAndPermissions(user))
//{
//    role: {
//        name: 'Admin',
//        permissions: [
//            {id: 1},
//            {id: 2}
//        ]
//    }
//}

Syntax

whitespace = ? Any whitespace character ? ;

simple_char = 'a'..'z' | 'A'..'Z' | '0'..'9' | '-' | '$' | '_' ;

simple_key = simple_char, { simple_char } ;

complex_key = '"', ? Backslash-escaped string of characters ?, '"' ;

key = simple_key | complex_key ;

expression = key, [ ':', { whitespace }, object ] ;

object = "{", { whitespace } [ expression, { ",", { whitespace }, expression } ], { whitespace }, "}";