object-fields

object-fields

Utility functions around object paths

Install

$ npm i --save object-fields

Usage

const objectFields = require('object-fields');

objectFields.split('data(file1,file2)');
// => ["data.file1", "data.file2"]
objectFields.join(['data', 'data']);
// => "data"
objectFields.join(['path.to.thing', 'path.to.other.thing']);
// => "path.to(thing,other.thing)"
objectFields.getParents(['child', 'parent.child', 'grandparent.parent.child']);
// => ['parent', 'grandparent', 'grandparent.parent']

const data = [{ id: 1, name: 'one' }, { id: 2, name: 'two' }];
objectFields.retain(data, ['name']); // updates data in place
// data => [{ name: 'one' }, { name: 'two' }]

Methods

split

Takes a shortened input string and separates it into an array.

join

Takes array of selectors and shortens it into a string

getParents

Takes array of selectors and returns unique, true parents.

retain

Takes object and array of selectors. Removes non selected fields from object.

Known Limitations

This package does not currently support escaping.