Installation

npm install --save @types/object-treeify

Summary

This package contains type definitions for object-treeify (https://github.com/blackflux/object-treeify).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/object-treeify.

index.d.ts

export type RenderFunction = (node: unknown) => unknown;

export type SortFunction = (firstKey: string, secondKey: string) => number;

export interface Options {
    joined?: boolean;
    spacerNoNeighbour?: string;
    spacerNeighbour?: string;
    keyNoNeighbour?: string;
    keyNeighbour?: string;
    separator?: string;
    renderFn?: RenderFunction;
    sortFn?: SortFunction | null;
    breakCircularWith?: string | null;
}

declare function treeify(tree: object, options: Options & { joined: false }): string[];

declare function treeify(tree: object, options?: Options & { joined?: true }): string;

declare function treeify(tree: object, options: Options): string | string[];

export default treeify;

Additional Details

• Last updated: Wed, 24 Jun 2026 18:33:23 GMT
• Dependencies: none

Credits

These definitions were written by Patrik Csak.