object-lib
Getting Started
$ npm install --save-dev object-lib copy
Functions
For more extensive examples, please refer to the tests.
align(obj: Object, ref: Object)
Align the ordering of one object recursively to a reference object.
Example:
import { align } from 'object-lib' ;
const obj = { k1: 1 , k2: 2 };
const ref = { k2: null, k1: null };
align (obj, ref);
// obj => { k2: 1, k1: 2 } copy
clone(obj: Object[], needles: Array = [])
Deep clone object.
Fields targeted by passed needles are created as a reference and not cloned.
Fields targeted by excluded needles are removed entirely from the result.
Needles are declared using the object-scan syntax.
Example:
import { clone } from 'object-lib' ;
const data = { a: {}, b: {}, c: {} };
const cloned = clone (data, [ 'b' , '!c' ]);
console. log (cloned);
// => { a: {}, b: {} }
console. log (cloned.a !== data.a);
// => true
console. log (cloned.b === data.b);
// => true copy
contains(tree: Object, subtree: Object)
Check if subtree is contained in tree recursively.
Different types are never considered contained .
Arrays are contained iff they are the same length and every
element is contained in the corresponding element.
Objects are contained if the keys are a subset,
and the respective values are contained .
All other types are contained if they match exactly (===).
Example:
import { contains } from 'object-lib' ;
contains ({ a: [ 1 , 2 ], b: 'c' }, { a: [ 1 , 2 ] });
// => true
contains ({ a: [ 1 , 2 ], b: 'c' }, { a: [ 1 ] });
// => false copy
jsonSmartParse(str: String)
Deals with parsing invalid json outputs that are commonly generated by llms
Merge(logic: Object = {})(...obj: Object[])
Allows merging of objects. The logic defines paths that map to a field, or a function, to merge by.
If a function is passed, it is invoked with the value, and the result is used as the merge identifier.
The paths are defined using object-scan syntax.
Example:
import { Merge } from 'object-lib' ;
Merge ()(
{ children: [{ id: 1 }, { id: 2 }] },
{ children: [{ id: 2 }, { id: 3 }] }
);
// => { children: [ { id: 1 }, { id: 2 }, { id: 2 }, { id: 3 } ] }
Merge ({ '**[*]' : 'id' })(
{ children: [{ id: 1 }, { id: 2 }] },
{ children: [{ id: 2 }, { id: 3 }] }
);
// => { children: [ { id: 1 }, { id: 2 }, { id: 3 } ] } copy
SafeProxy(obj: Object)
Creates a "wrapper" proxy object that errors when a (nested) property is accessed that does not exist.
Normally this would just return "undefined".
Template(obj: Object)
Takes input "template" obj. This is expected to be a (deeply nested) object.
Rendering works very similar to mustache templates, some features are not supported yet.
For details see tests.
variables()
Returns all unique variables in template
render(vars: { k: v })
Renders variables into deep copy of obj