Interface EntityAttrRangeQueryOptions<V, L>

Entity attribute range query options for a ReadonlyEntityCollection.

interface EntityAttrRangeQueryOptions {
    attr?: L;
    by?: string;
    limit?: number;
    lower?: V;
    lowerOpen?: boolean;
    reverse?: boolean;
    signal?: AbortSignal;
    type?: string;
    upper?: V;
    upperOpen?: boolean;
}

Type Parameters

Hierarchy

Properties

attr? by? limit? lower? lowerOpen? reverse? signal? type? upper? upperOpen?

Properties

Optional Readonly attr

attr?: L

Attributes to retrieve. Defaults to retrieve all attributes.

Optional Readonly by

by?: string

Attribute to query by. Defaults to $id.

Optional Readonly limit

limit?: number

Maximum number of results to return.

Optional Readonly lower

lower?: V

Lower bound of the range.

Optional Readonly lowerOpen

lowerOpen?: boolean

Whether the lower bound is open. Defaults to false.

Optional Readonly reverse

reverse?: boolean

Iterates in reverse order.

Optional signal

signal?: AbortSignal

An optional AbortSignal that can be used to abort an async task.

Optional Readonly type

type?: string

Entity type to use.

Optional Readonly upper

upper?: V

Upper bound of the range.

Optional Readonly upperOpen

upperOpen?: boolean

Whether the upper bound is open. Defaults to true.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc