Type Alias QueryOptions

QueryOptions: {
    endIndex?: number;
    endPosition?: Point;
    matchLimit?: number;
    maxStartDepth?: number;
    startIndex?: number;
    startPosition?: Point;
    timeoutMicros?: number;
}

Type declaration

  • OptionalendIndex?: number

    The ending byte offset in which the query will be executed.

  • OptionalendPosition?: Point

    The ending row/column position in which the query will be executed.

  • OptionalmatchLimit?: number

    The maximum number of in-progress matches for this cursor. The limit must be > 0 and <= 65536.

  • OptionalmaxStartDepth?: number

    The maximum start depth for a query cursor.

    This prevents cursors from exploring children nodes at a certain depth. Note if a pattern includes many children, then they will still be checked.

    The zero max start depth value can be used as a special behavior and it helps to destructure a subtree by staying on a node and using captures for interested parts. Note that the zero max start depth only limit a search depth for a pattern's root node but other nodes that are parts of the pattern may be searched at any depth what defined by the pattern structure.

  • OptionalstartIndex?: number

    The starting byte offset in which the query will be executed.

  • OptionalstartPosition?: Point

    The starting row/column position in which the query will be executed.

  • OptionaltimeoutMicros?: number

    The maximum duration in microseconds that query execution should be allowed to take before halting.

    If query execution takes longer than this, it will halt early, returning None.

Settings

Member Visibility