Function children

Returns the direct children of a tree-like object as a pairing of node name and value. Supports basic objects, Maps and arrays.

Sub-children are included as an object blob.

Example: Simple object

const o = {
 colour: {
   r: 0.5, g: 0.5, b: 0.5
 }
};

const children = [ ...Trees.children(o) ];
// Children:
// [
//  { name: "colour", value: { b: 0.5, g: 0.5, r: 0.5 } }
// ]
const subChildren = [ ...Trees.children(o.colour) ];
// [ { name: "r", value: 0.5 }, { name: "g", value: 0.5 }, { name: "b", value: 0.5 } ]
Copy

Arrays are assigned a name based on index.

Example: Arrays

const colours = [ { r: 1, g: 0, b: 0 }, { r: 0, g: 1, b: 0 }, { r: 0, g: 0, b: 1 } ];
// Children: 
// [
//  { name: "array[0]", value: {r:1,g:0,b:0} },
//  { name: "array[1]", value: {r:0,g:1,b:0} },
//  { name: "array[2]", value: {r:0,g:0,b:1} },
// ]
Copy

Pass in options.name (eg 'colours') to have names generated as 'colours[0]', etc. Options can also be used to filter children. By default all direct children are returned.