Interface MatchCommon
interface MatchCommon {
hasOwnOnly?: boolean;
maxDepth?: number;
maxResults?: number;
maxVisits?: number;
pathPrefix?: PropertyPath;
stopAt?: PropertyPath;
}
hasOwnOnly?: boolean;
maxDepth?: number;
maxResults?: number;
maxVisits?: number;
pathPrefix?: PropertyPath;
stopAt?: PropertyPath;
}
Hierarchy
- PropertyPathMap.Options.Common
- MatchCommon (View Summary)
Properties
OptionalhasOwnOnly
hasOwnOnly?: boolean
When true, every path segment must be an own property of the candidate value reached at that depth.
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.
OptionalpathPrefix
Absolute stored path selecting the trie subtree where traversal begins.
OptionalstopAt
Absolute stored path whose entry is included while every descendant beneath it is pruned.
Options shared by every candidate-object matching iterator.