ixfx
    Preparing search index...

    Functions

    asDynamicTraversable

    Returns a projection of node as a dynamic traversable. This means that the tree structure is dynamically created as last-minute as possible.

    children

    Yields the direct (ie. non-recursive) children of a tree-like object as a pairing of node name and value. Supports basic objects, Maps and arrays.

    create

    Reads all fields and sub-fields of node, returning as a basic tree structure. The structure is a snapshot of the object. If the object changes afterwards, the tree will remain the same.

    createSimplified

    Returns a copy of node with its (and all its children's) parent information removed.

    createWrapped

    Reads all fields and sub-fields of node, returning as a 'wrapped' tree structure.

    depthFirst
    getByPath

    Returns the closest matching entry, tracing path in an array, Map or simple object. Returns an entry with undefined value at the point where tracing stopped. Use traceByPath to step through all the segments.

    prettyPrint

    Returns a human-friendly debug string for a tree-like structure

    prettyPrintEntries

    Helper function to get a 'friendly' string representation of an array of TraverseObjectEntry.

    toStringDeep

    Returns a debug string representation of the node (recursive)

    traceByPath

    Enumerates over children of node towards the node named in path. This is useful if you want to get the interim steps to the target node.

    Type Aliases

    ChildrenOptions
    CreateOptions