Interface OfflineRegionFeatureBatchV1<T>

One stored answer to a canonical query.

The envelope records the window it covers and whether more records existed, so a later read can tell the difference between "this is everything" and "this is the first page" without guessing.

interface OfflineRegionFeatureBatchV1<T> {
    exceededTransferLimit: boolean;
    features: readonly HonuaTypedFeature<T>[];
    fields?: readonly HonuaFieldInfo[];
    kind: "honua.offline-feature-batch";
    pagination: {
        limit?: number;
        offset: number;
    };
    totalCount?: number;
    version: "1.0";
}

Type Parameters

  • T = Record<string, unknown>

Properties

exceededTransferLimit features fields? kind pagination totalCount? version

Properties

ReadonlyexceededTransferLimit

exceededTransferLimit: boolean

True when the source signalled that more records matched than were captured.

Readonlyfeatures

features: readonly HonuaTypedFeature<T>[]

Optional Readonlyfields

fields?: readonly HonuaFieldInfo[]

Readonlykind

kind

Readonlypagination

pagination: {
    limit?: number;
    offset: number;
}

Window this batch covers, in the canonical query's own pagination terms.

Optional ReadonlytotalCount

totalCount?: number

Readonlyversion

version

Settings

Member Visibility

On This Page

Properties