Interface: ContextfulOptions

What contextful(fn, opts) takes. Everything is optional; the defaults are the honest minimum.

Properties

anchor?

optional anchor?: AnchorSource

The element this action lives at. Required for watch; a getter is the SSR-safe form (nothing reads the DOM until the session attaches).

expect?

optional expect?: ActionExpectation

Defined in: src/contextful/types.ts:100

What the app expects to SEE at the anchor when this action really happens.

include?

optional include?: readonly string[]

Defined in: src/contextful/types.ts:91

THE VALUE ALLOWLIST — payload key names that may be captured BY VALUE, plus the reserved ERROR_MESSAGE. Nothing outside it ever carries a value into the record through this wrapper (law 1). Absent means: no values at all, which is the honest minimum.

onStimulus?

optional onStimulus?: (event) => void

Defined in: src/contextful/types.ts:109

Anchor events NO invocation claimed — the human moving around the control without performing the action (law 3: outside the window is stimulus, never part of the action). Isolated: a listener that throws never reaches the app's own event dispatch.

Parameters

event

SensedEvent

Returns

void

principal?

optional principal?: DirectPrincipal

Defined in: src/contextful/types.ts:102

Who a direct (app-initiated) call is filed under. Default 'user'.

redact?

optional redact?: (value, key) => unknown

Defined in: src/contextful/types.ts:98

The app's own redactor, run over every allowlisted value before it is recorded. The library never invents a redaction policy — it only promises that yours is the last word. Return whatever should stand in the record; a redactor that throws costs the value its slot and nothing else.

optional watch?: boolean

Defined in: src/contextful/types.ts:79

Attach anchor-scoped listeners and one observer at anchor. Off by default — sensing is the half that touches the DOM, so it is the half an app opts into.

ContextfulOptions

On this page