lodash-walk-object/lib/models.d.ts

Walk all properties deep in object with lodash help

export interface Circ {
    /**
     * Path whose value points to an already visited object.
     */
    pathToObj: string;
    /**
     * Lodash path of the original object.
     */
    circuralTargetPath: string | unknown;
}
export declare namespace Models {
    interface InDBType {
        target: object;
        path: string;
    }
    interface Ver {
        v: unknown;
        p: string;
        parent?: Ver;
        isGetter?: boolean;
        /**
         * Active ancestor chain used by breadth-first traversal when
         * shared objects should not be treated as circular.
         */
        ancestors?: InDBType[];
    }
    interface StartIteratorOptions {
        walkGetters?: boolean;
        /**
         * When false, every repeated object reference is treated as circular.
         *
         * When true, only references to objects in the current ancestor chain
         * are treated as circular. Shared objects are walked for every path.
         *
         * @default false
         */
        considerSharedObjects?: boolean;
        /**
         * Circular checking is especially useful for breadth-first traversal.
         */
        checkCircural?: boolean;
        breadthWalk?: boolean;
        include?: string[];
        exclude?: string[];
    }
    interface AdditionalIteratorOptions extends StartIteratorOptions {
        skipObject?: () => void;
        isGetter?: boolean;
        /**
         * Breadth walk skips the contents of circular objects.
         */
        isCircural?: boolean;
        exit?: () => void;
    }
    interface InternalValues extends AdditionalIteratorOptions {
        stack?: InDBType[];
        circural?: Circ[];
        hasIterator?: boolean;
        _valueChanged: boolean;
        _skip: boolean;
        _exit: boolean;
    }
}
export type Iterator = (value: unknown, lodashPath: string, changeValueTo: (newValue: unknown) => void, options?: Models.AdditionalIteratorOptions) => void;
export type UnknownRecord = Record<PropertyKey, unknown>;
export interface PreparedPath {
    contextPath: string;
    property: string | number;
}
export interface PropertyEntry {
    key: string;
    value: unknown;
    isGetter: boolean;
}