Interface DisposableHandleSpec`Experimental`

Adapter-supplied behaviour for createDisposableHandle.

interface DisposableHandleSpec {
    adapterId: string;
    artifact: AnalyticsArtifact;
    extra?: Readonly<Record<string, unknown>>;
    onLinkedState?: (
        state: AnalyticsLinkedState,
        artifact: AnalyticsArtifact,
    ) => void;
    describe(artifact: AnalyticsArtifact, state: AnalyticsLinkedState): string;
    onDispose(): void;
    onInvalidate?(artifact: AnalyticsArtifact): void;
    onUpdate?(
        artifact: AnalyticsArtifact,
        decision: AnalyticsUpdateDecision,
    ): void;
}

Index

Properties

adapterId artifact extra? onLinkedState?

Methods

describe onDispose onInvalidate? onUpdate?

Properties

`Readonly` `Experimental`adapterId

adapterId: string

`Readonly` `Experimental`artifact

artifact: AnalyticsArtifact

`Optional` `Readonly` `Experimental`extra

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

Extra own-properties merged onto the handle (adapter-specific accessors).

`Optional` `Readonly` `Experimental`onLinkedState

onLinkedState?: (
state: AnalyticsLinkedState,
artifact: AnalyticsArtifact,
) => void

Methods

describe

describe(artifact: AnalyticsArtifact, state: AnalyticsLinkedState): string
Experimental
Produce the current accessible description. Called lazily.
Parameters
- artifact: AnalyticsArtifact
- state: AnalyticsLinkedState
Returns string
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/handle.ts:32

onDispose

onDispose(): void
Experimental
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/handle.ts:38

`Optional`onInvalidate

onInvalidate?(artifact: AnalyticsArtifact): void
Experimental
Called only when the decision is invalidate. Runs before onUpdate.
Parameters
- artifact: AnalyticsArtifact
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/handle.ts:36

`Optional`onUpdate

onUpdate?(artifact: AnalyticsArtifact, decision: AnalyticsUpdateDecision): void
Experimental
Called for both patch and invalidate, after the stored artifact swaps.
Parameters
- artifact: AnalyticsArtifact
- decision: AnalyticsUpdateDecision
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/handle.ts:34