TraverseOptions

TraverseOptions = GetObjectKeysOptions & object

Defined in: packages/core/src/object/traverse.ts:66

Type Declaration

traverseArrays?

optional traverseArrays?: boolean

Whether to traverse into array elements

Default

true

traverseCustomObjects?

optional traverseCustomObjects?: TraverseCustomObjectsOption

Controls traversal into custom object (user-defined class instances) properties - false: Don’t traverse custom objects (treat as opaque) - Constructor[]: Only traverse instances of these classes (or their descendants) - (value: object) => boolean: Custom predicate to determine traversability

Default

false

traverseMapKeys?

optional traverseMapKeys?: boolean

Whether to traverse into Map keys specifically Only applies when traverseMaps is true

Default

false

traverseMaps?

optional traverseMaps?: boolean

Whether to traverse into Map keys and values

Default

true

traversePlainObjects?

optional traversePlainObjects?: boolean

Whether to traverse into plain object (POJO) properties

Default

true

traverseSets?

optional traverseSets?: boolean

Whether to traverse into Set values

Default

true

visitObjects?

optional visitObjects?: boolean

Whether to call the visitor on object values (arrays, maps, sets, plain objects, custom objects)

Default

true

visitPrimitives?

optional visitPrimitives?: boolean

Whether to call the visitor on primitive values (string, number, boolean, null, undefined, symbol, bigint)

Default

true