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

    Interface Result<T>

    Unified query result envelope. Wraps (does not replace) HonuaTypedQueryResponse<T> and HonuaOgcFeatureCollectionResponse; adapters fill the optional fields that their underlying response carries and leave the rest undefined.

    const result: Result<{ name: string }> = await source.query({ pagination: { limit: 100 } });
    for (const feature of result.features) {
      console.log(feature.attributes.name, feature.geometry?.type);
    }
    if (result.exceededTransferLimit) {
      // re-issue with pagination.offset or use source.queryAll() to drain
    }
    interface Result<T = Record<string, unknown>> {
        aggregateRows?: readonly Record<string, unknown>[];
        degraded?: readonly DegradedReason[];
        exceededTransferLimit: boolean;
        extent?: HonuaExtent;
        features: readonly HonuaTypedFeature<T>[];
        fields?: readonly HonuaFieldInfo[];
        totalCount?: number;
    }

    Type Parameters

    • T = Record<string, unknown>

    Hierarchy (View Summary)

    Index

    Properties

    aggregateRows? degraded? exceededTransferLimit extent? features fields? totalCount?

    Properties

    aggregateRows?: readonly Record<string, unknown>[]

    Aggregated rows when the query carried an aggregation spec.

    degraded?: readonly DegradedReason[]

    Degradation flags emitted by the source while serving this query.

    exceededTransferLimit: boolean

    True if the server signalled that more records exist than were returned.

    extent?: HonuaExtent

    Spatial extent of the returned features (extent-only query response).

    features: readonly HonuaTypedFeature<T>[]

    Returned features. Empty array (not undefined) when nothing matched.

    fields?: readonly HonuaFieldInfo[]

    Field schema as returned by the protocol, when the response carried one.

    totalCount?: number

    Total count when known (counts request, OGC numberMatched).

    Settings

    Member Visibility

    On This Page

    Properties