Interface PathKeyIteratorOptions
interface PathKeyIteratorOptions {
arrayIndex?: boolean;
hasOwnOnly?: boolean;
maxDepth?: number;
maxResults?: number;
maxVisits?: number;
prefixPath?: PropertyPath;
stopPath?: PropertyPath;
}
arrayIndex?: boolean;
hasOwnOnly?: boolean;
maxDepth?: number;
maxResults?: number;
maxVisits?: number;
prefixPath?: PropertyPath;
stopPath?: PropertyPath;
}
Hierarchy
- PropertyPathTraversalLimits
- PathKeyIteratorOptions (View Summary)
Index
Properties
OptionalarrayIndex
arrayIndex?: boolean
Whether numeric array indexes are included.
OptionalhasOwnOnly
hasOwnOnly?: boolean
Whether traversal is restricted to enumerable own 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.
OptionalprefixPath
Absolute enumerable property path selecting the object branch where traversal begins.
OptionalstopPath
Absolute property path yielded as terminal while pruning all descendants beneath it.
Defines bounded traversal options for pathKeyIterator.
Returned paths remain absolute when a prefix is selected.
stopPathmust equal or descend fromprefixPathwhen both are supplied.