@honua/sdk-js
    Preparing search index...

    Interface CanonicalQuery

    Serializable form of the current canonical Query. AbortSignal is deliberately excluded: cancellation belongs to execution, never identity.

    interface CanonicalQuery {
        aggregation?: AggregationSpec;
        filter?: QueryFilterExpression;
        orderBy?: readonly { direction: "asc" | "desc"; field: string }[];
        outFields?: readonly string[];
        outSr?: string | number;
        pagination?: { limit?: number; offset?: number };
        returnGeometry?: boolean;
        spatialFilter?: CanonicalSpatialFilter;
        temporalFilter?: QueryTemporalFilter;
        where?: { expression: string; kind: "source-native" };
    }
    Index

    Properties

    aggregation? filter? orderBy? outFields? outSr? pagination? returnGeometry? spatialFilter? temporalFilter? where?

    Properties

    aggregation?: AggregationSpec
    filter?: QueryFilterExpression

    Typed semantic filter carried verbatim into the IR so it participates in hashQueryIr / hashQueryPlan exactly as every other query member does. A compiler that cannot express it refuses; it is never dropped in planning.

    orderBy?: readonly { direction: "asc" | "desc"; field: string }[]
    outFields?: readonly string[]
    outSr?: string | number
    pagination?: { limit?: number; offset?: number }
    returnGeometry?: boolean
    spatialFilter?: CanonicalSpatialFilter
    temporalFilter?: QueryTemporalFilter

    Canonical temporal constraint (instant or interval, optionally field bound).

    where?: { expression: string; kind: "source-native" }

    The current contract carries a source-native string escape hatch.

    Settings

    Member Visibility

    On This Page

    Properties