Type Alias Snapshot<R, K, V, P>

Snapshot: Readonly<
    {
        callback: Callback<P, K, V, R>;
        options: Readonly<Options<P, K, V>>;
        root: R;
        visitLog?: VisitLog<P, K> | null;
    },
>

Readonly object containing the arguments given to deepIterate, and a visit log if one was generated.

Type Parameters

R extends P
K = unknown
V = unknown
P extends object = object

Remarks

Two objects of this type are created after the traverse:

One is bound to the callback, and it may or may not include the visit log according to options.exposeVisitLog.
The other one is returned at the end of the traverse, and it always includes the visit log if available.
In both objects, the read-only copy of the options is the same.

Since

3.0.0-beta.3