Interface PropertyPathTraversalLimits
interface PropertyPathTraversalLimits {
maxDepth?: number;
maxResults?: number;
maxVisits?: number;
}
maxDepth?: number;
maxResults?: number;
maxVisits?: number;
}
Hierarchy
- PropertyPathTraversalLimits (View Summary)
Properties
OptionalmaxDepth
maxDepth?: number
Maximum number of property-key segments traversed beneath a selected prefix, or beneath the root when no prefix
is supplied. A value of 0 selects only the prefix itself when the iterator supports a prefix.
OptionalmaxResults
maxResults?: number
Maximum number of paths or entries yielded by one traversal. Reaching this limit truncates normally.
OptionalmaxVisits
maxVisits?: number
Maximum number of object properties or trie nodes processed during iterative traversal. Exceeding this limit throws.
Defines common defensive limits for property-path traversal.
All limits must be non-negative safe integers.
maxDepthestablishes a structural boundary,maxResultsends an iterator normally after the requested number of results, andmaxVisitsthrows aRangeErrorbefore another property or trie node is processed. Trie-backed collections may impose lower constructor-level caps.