@metreeca/qest - v0.9.2
    Preparing search index...

    Type Alias Query

    Query: Model & {
        "@"?: number;
        "#"?: number;
        readonly [lt: `<${string}`]: Literal;
        readonly [gt: `>${string}`]: Literal;
        readonly [lte: `<=${string}`]: Literal;
        readonly [gte: `>=${string}`]: Literal;
        readonly [like: `~${string}`]: string;
        readonly [any: `?${string}`]: Options;
        readonly [all: `!${string}`]: Options;
        readonly [focus: `*${string}`]: Options;
        readonly [order: `^${string}`]: number | "desc" | "asc";
    }

    Collection query.

    Extends Model with filtering, ordering, and pagination criteria for collections.

    Warning

    Query processors must reject queries with an error if they reference undefined properties or provide projections or constraints of mismatched types for defined properties.

    Type Declaration

    • readonly [lt: `<${string}`]: Literal

      Less-than filter ("<expression": value).

      Includes resources where at least one expression value is less than the literal.

    • readonly [gt: `>${string}`]: Literal

      Greater-than filter (">expression": value).

      Includes resources where at least one expression value is greater than the literal.

    • readonly [lte: `<=${string}`]: Literal

      Less-than-or-equal filter ("<=expression": value).

      Includes resources where at least one expression value is less than or equal to the literal.

    • readonly [gte: `>=${string}`]: Literal

      Greater-than-or-equal filter (">=expression": value).

      Includes resources where at least one expression value is greater than or equal to the literal.

    • readonly [like: `~${string}`]: string

      Stemmed word search filter ("~expression": value).

      Includes resources where at least one expression value contains all word stems from the search string.

    • readonly [any: `?${string}`]: Options

      Disjunctive matching filter ("?expression": value).

      Includes resources where at least one expression value equals one of the options; null matches undefined.

    • readonly [all: `!${string}`]: Options

      Conjunctive matching filter ("!expression": value).

      Includes resources whose expression values include all specified options; for multi-valued properties.

    • readonly [focus: `*${string}`]: Options

      Focus ordering ("*expression": options).

      Orders results prioritising resources whose expression value appears in the specified Options; matching resources appear before non-matching ones; overrides regular sorting criteria.

    • readonly [order: `^${string}`]: number | "desc" | "asc"

      Sort ordering ("^expression": priority).

      Orders results by expression value; the sign gives direction (positive for ascending, negative for descending); the absolute value gives 1-based precedence (1 is highest priority); zero is ignored; "asc" and "desc" are shorthands for ±1.

    • Optional Readonly@?: number

      Pagination offset ("@": number).

      Skips the first number resources from the filtered and ordered result set; zero is ignored.

    • Optional Readonly#?: number

      Pagination limit ("#": number).

      Returns at most number resources from the result set after applying offset; zero is ignored.

    Model for resource projection