get-jpaths
    Preparing search index...

    Interface GetJPathsOptions

    interface GetJPathsOptions {
        excludeJPathRegexps?: RegExp[];
        excludeJPaths?: string[];
        includeJPathRegexps?: RegExp[];
        includeJPaths?: string[];
        maxArrayElements?: number;
        maxDepth?: number;
        modifiers?: Record<string, (value: unknown) => unknown>;
    }
    Index

    Properties

    excludeJPathRegexps?: RegExp[]

    Array of RegExp instances; jpaths matching any of these regexps are excluded. Overrides inclusion filters (i.e., if a jpath is in excludeJPaths, it's never included).

    []
    
    excludeJPaths?: string[]

    Array of string jpaths to exclude from the results. If omitted or empty, no paths are excluded if included by includeJPaths.

    includeJPathRegexps?: RegExp[]

    Array of RegExp instances; only jpaths matching any of these regexps are included. If omitted or empty, all paths are included unless excluded by excludeJPaths.

    []
    
    includeJPaths?: string[]

    Array of string jpaths to include in the results. If omitted or empty, all paths are included unless excluded by excludeJPaths.

    maxArrayElements?: number

    Maximum number of array elements to traverse at each level.

    5
    
    maxDepth?: number

    Maximum depth to traverse nested objects/arrays.

    3
    
    modifiers?: Record<string, (value: unknown) => unknown>

    Modifiers to apply to values before including them in the results. They are evaluated while traversing the object so the value do not have to be primitive before applying them.