Interface TraverseOptions

Declare extra subschemas using non-empty paths relative to each object schema. Called once per visited object, on the input node before child mutations. Built-in locations and duplicate paths are visited only once. Targets must be object or boolean schemas; intermediate objects/arrays are containers.

Allow callbacks to return undefined (or nothing) to keep the node passed to them, including any in-place edits. This also applies to promises resolving to undefined. When false (the default), an undefined return throws a TypeError with the node path. This option does not remove nodes.

true to call the mutation function before visiting each schema's children. Despite the name, this is preorder depth-first traversal, not level-by-level breadth-first traversal.

Set this to true if you want to merge the returned value of the mutation function into the original schema.

true if you want the original schema that was provided to be directly modified by the provided mutation/merge function To preserve cyclical refs this is necessary.

Callback path format. Defaults to JSONPath; JSON Pointer uses RFC 6901 strings with an empty root path.

Set this to true if you don't want to call the mutator function on the root schema.