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

    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 = Record<string, unknown>> {
        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>
    Index

    Properties

    exceededTransferLimit features fields? kind pagination totalCount? version

    Properties

    exceededTransferLimit: boolean

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

    features: readonly HonuaTypedFeature<T>[]
    fields?: readonly HonuaFieldInfo[]
    kind: "honua.offline-feature-batch"
    pagination: { limit?: number; offset: number }

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

    totalCount?: number
    version: "1.0"

    Settings

    Member Visibility

    On This Page

    Properties