@ac-essentials/misc-util
    Preparing search index...

    Type Alias TraverseOptions

    TraverseOptions: GetObjectKeysOptions & {
        traverseArrays?: boolean;
        traverseCustomObjects?: TraverseCustomObjectsOption;
        traverseMapKeys?: boolean;
        traverseMaps?: boolean;
        traversePlainObjects?: boolean;
        traverseSets?: boolean;
        visitObjects?: boolean;
        visitPrimitives?: boolean;
    }

    Type Declaration

    • OptionaltraverseArrays?: boolean

      Whether to traverse into array elements

      true
    • OptionaltraverseCustomObjects?: 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
      false
    • OptionaltraverseMapKeys?: boolean

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

      false
    • OptionaltraverseMaps?: boolean

      Whether to traverse into Map keys and values

      true
    • OptionaltraversePlainObjects?: boolean

      Whether to traverse into plain object (POJO) properties

      true
    • OptionaltraverseSets?: boolean

      Whether to traverse into Set values

      true
    • OptionalvisitObjects?: boolean

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

      true
    • OptionalvisitPrimitives?: boolean

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

      true

    Settings

    Member Visibility