augment-vir - v32.2.2
    Preparing search index...

    Type Alias PathsOptions

    Options for Paths.

    Copied from the PathsOptions type in type-fest v5.6 so that this package's public types do not depend on type-fest (see the note in type-checks.ts).

    @augment-vir/common

    type PathsOptions = {
        bracketNotation?: boolean;
        depth?: number;
        leavesOnly?: boolean;
        maxRecursionDepth?: number;
    }
    Index
    bracketNotation? depth? leavesOnly? maxRecursionDepth?
    bracketNotation?: boolean

    Use bracket notation for array indices and numeric object keys.

    false
    depth?: number

    Only include paths at the specified depth. By default all paths up to PathsOptions.maxRecursionDepth are included. Depth starts at 0 for root properties.

    number
    leavesOnly?: boolean

    Only include leaf paths in the output.

    false
    maxRecursionDepth?: number

    The maximum depth to recurse when searching for paths. Range: 0 ~ 10.

    5

    Settings
    Member Visibility

    On This Page
    Properties