export interface TreeIteratorOptions {
    readonly delay?: number | undefined;
    readonly loop?: boolean | undefined;
}
export type NextOptions = Pick<TreeIteratorOptions, 'delay' | 'loop'>;
type GetNextOptions = Pick<NextOptions, 'loop'>;
export interface TreeIterator<Node extends AnyObject, StopNode extends Node = Node> {
    readonly next: (options?: NextOptions) => void;
    readonly back: (options?: NextOptions) => void;
    readonly getNext: (options?: GetNextOptions) => StopNode | undefined;
    readonly getBack: (options?: GetNextOptions) => StopNode | undefined;
    readonly isCanNext: (options?: GetNextOptions) => boolean;
    readonly isCanBack: (options?: GetNextOptions) => boolean;
    readonly isPending: boolean;
    /** Cancel the delayed switch. */
    readonly cancel: VoidFunction;
}
export interface TreeScope<Node extends AnyObject, StopNode extends Node> {
    readonly getCurrentNode: () => Node | undefined;
    readonly childrenProp: keyof Node;
    readonly parentProp: keyof Node;
    readonly stop: ((node: Node) => node is StopNode) | ((node: Node) => boolean);
}
export declare function getTreeIterator<Node extends AnyObject, StopNode extends Node = Node>(scope: TreeScope<Node, StopNode>, onSwitch: (nextNode: StopNode) => unknown, options?: TreeIteratorOptions): TreeIterator<Node, StopNode>;
export {};