Interface EditEnvelope<T>

Single-source edit envelope. Adapters that do not advertise applyEdits throw HonuaCapabilityNotSupportedError rather than dropping records.

interface EditEnvelope<T> {
    adds?: readonly CanonicalFeature<T>[];
    deletes?: readonly FeatureId[];
    rollbackOnFailure?: boolean;
    signal?: AbortSignal;
    updates?: readonly CanonicalFeature<T>[];
}

Type Parameters

T = Record<string, unknown>

Index

Properties

adds? deletes? rollbackOnFailure? signal? updates?

Properties

`Optional`adds

adds?: readonly CanonicalFeature<T>[]

`Optional`deletes

deletes?: readonly FeatureId[]

`Optional`rollbackOnFailure

rollbackOnFailure?: boolean

When true (and the protocol honors it) the edit batch is atomic.

`Optional`signal

signal?: AbortSignal

Caller-supplied cancellation.

`Optional`updates

updates?: readonly CanonicalFeature<T>[]