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.

Example

const result: Result<{ name: string }> = await source.query({ where: "1=1" });
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> {
    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>

Properties

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

Properties

OptionalaggregateRows

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

Aggregated rows when the query carried an aggregation spec.

Optionaldegraded

degraded?: readonly DegradedReason[]

Degradation flags emitted by the source while serving this query.

exceededTransferLimit

exceededTransferLimit: boolean

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

Optionalextent

extent?: HonuaExtent

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

features

features: readonly HonuaTypedFeature<T>[]

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

Optionalfields

fields?: readonly HonuaFieldInfo[]

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

OptionaltotalCount

totalCount?: number

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

Settings

Member Visibility

On This Page

Properties