Interface HonuaServerFeatureChangeEnvelope<TFeature>

Shape of the envelope honua-server writes to the /api/v1/streaming/features SSE stream. Each envelope carries the service / layer scope, ordering metadata, and one or more feature changes.

interface HonuaServerFeatureChangeEnvelope<TFeature> {
    attributes?: Readonly<Record<string, unknown>>;
    changes?: readonly HonuaServerFeatureChange<TFeature>[];
    cursor?: string;
    deltaToken?: string;
    eventId?: string;
    feature?: TFeature;
    featureId?: FeatureId;
    geometry?: unknown;
    kind?: string;
    layerId?: string | number;
    objectId?: FeatureId;
    op?:
        | "delete"
        | "snapshot"
        | "update"
        | "insert";
    operation?: "delete" | "update" | "insert";
    sequence?: number;
    serviceId?: string;
    sourceId?: string;
    timestamp?: string;
    type?: string;
    updatedAt?: string;
    version?: number;
    watermark?: string;
}

Type Parameters

  • TFeature = unknown

Properties

attributes? changes? cursor? deltaToken? eventId? feature? featureId? geometry? kind? layerId? objectId? op? operation? sequence? serviceId? sourceId? timestamp? type? updatedAt? version? watermark?

Properties

Optional Readonlyattributes

attributes?: Readonly<Record<string, unknown>>

Current honua-server full attribute snapshot for insert/update events.

Optional Readonlychanges

changes?: readonly HonuaServerFeatureChange<TFeature>[]

Optional Readonlycursor

cursor?: string

Optional ReadonlydeltaToken

deltaToken?: string

Optional ReadonlyeventId

eventId?: string

Optional Readonlyfeature

feature?: TFeature

Optional ReadonlyfeatureId

featureId?: FeatureId

Optional Readonlygeometry

geometry?: unknown

Current honua-server GeoJSON geometry field.

Optional Readonlykind

kind?: string

change (or feature-change) is the default envelope kind.

Optional ReadonlylayerId

layerId?: string | number

Optional ReadonlyobjectId

objectId?: FeatureId

Optional Readonlyop

op?:
    | "delete"
    | "snapshot"
    | "update"
    | "insert"

Single-change envelopes inline the change instead of a changes array.

Optional Readonlyoperation

operation?: "delete" | "update" | "insert"

Current honua-server wire field; normalized to HonuaServerFeatureChange.op.

Optional Readonlysequence

sequence?: number

Optional ReadonlyserviceId

serviceId?: string

Optional ReadonlysourceId

sourceId?: string

Optional Readonlytimestamp

timestamp?: string

Optional Readonlytype

type?: string

Pass-through status / heartbeat / error envelopes.

Optional ReadonlyupdatedAt

updatedAt?: string

Optional Readonlyversion

version?: number

Optional Readonlywatermark

watermark?: string

Settings

Member Visibility

On This Page

Properties