Interface Iteration

Limits for insertion-order entries, keys, and values iterators.

interface Iteration {
    maxDepth?: number;
    maxResults?: number;
    maxVisits?: number;
}
Hierarchy
Index
maxDepth? maxResults? maxVisits?
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.

maxResults?: number

Maximum number of paths or entries yielded by one traversal. Reaching this limit truncates normally.

maxVisits?: number

Maximum number of object properties or trie nodes processed during iterative traversal. Exceeding this limit throws.

Settings
Member Visibility

On This Page
Properties