@truenas/api-client
    Preparing search index...

    Type Alias QueryOperator

    QueryOperator:
        | "="
        | "!="
        | ">"
        | ">="
        | "<"
        | "<="
        | "~"
        | "in"
        | "nin"
        | "rin"
        | "rnin"
        | "^"
        | "!^"
        | "$"
        | "!$"

    Typed query grammar for middleware .query-style methods.

    This module is hand-maintained (template in scripts/generate-api-interface) and copied into the generated output verbatim: the query grammar is middleware framework semantics — one recursive filter language shared by every query method — which JSON Schema cannot express, so it is the one deliberate exception to schema-derived typing. The generator instantiates these generics with the entity type of each query method.

    Type Declaration

    • "="
    • "!="
    • ">"
    • ">="
    • "<"
    • "<="
    • "~"

      Case-insensitive regex match.

    • "in"

      Value in / not in the given list.

    • "nin"
    • "rin"

      Given value in / not in the field's list.

    • "rnin"
    • "^"

      Starts with / does not start with.

    • "!^"
    • "$"

      Ends with / does not end with.

    • "!$"