hacifootprint
hcifootprintInterfaces

ConnectActionOptions<Input, Output, Id>

Interface: ConnectActionOptions<Input, Output, Id>

Defined in: src/action/types.ts:357

Facts supplied when opening one live binding.

Extends

Type Parameters

Input

Input

Output

Output = unknown

Id

Id extends string = string

Properties

busy?

readonly optional busy?: () => string | undefined

Defined in: src/action/types.ts:344

Returns

string | undefined

Inherited from

ActionBindingUpdate.busy


coverage?

readonly optional coverage?: BindingCoverage

Defined in: src/action/types.ts:345

Inherited from

ActionBindingUpdate.coverage


enabled?

readonly optional enabled?: () => boolean | undefined

Defined in: src/action/types.ts:343

Returns

boolean | undefined

Inherited from

ActionBindingUpdate.enabled


humanReporting?

readonly optional humanReporting?: HumanReporting

Defined in: src/action/types.ts:347

Inherited from

ActionBindingUpdate.humanReporting


input?

readonly optional input?: () => Input

Defined in: src/action/types.ts:342

Live value reader. Direct connection invocation reads it at invocation; a principal port's offers() reads and retains it while minting an exact bound offer. The definition-side payload shape is inputSchema.

Returns

Input

Inherited from

ActionBindingUpdate.input


instance?

readonly optional instance?: string

Defined in: src/action/types.ts:363


invokedBy?

readonly optional invokedBy?: "agent" | "system" | "user"

Defined in: src/action/types.ts:384

Who invokes THIS connection through its direct doors (invoke, invokeContinuation). Declared, never inferred: humanReporting says which subsystem reports a person's interaction, not who called invoke(). Checked against the definition's principal.mayInvoke at connect, so it can never file an invocation under a principal the definition refuses. Absent: direct invocations stay 'unknown'. A caller other than this one uses the principal port (runtime.forPrincipal), which stamps its own.


locators?

readonly optional locators?: readonly Binding[]

Defined in: src/action/types.ts:346

Inherited from

ActionBindingUpdate.locators


node

readonly node: string

Defined in: src/action/types.ts:362


onInvocation?

readonly optional onInvocation?: (invocation, settlement) => void | PromiseLike<void>

Defined in: src/action/types.ts:369

Observe every invocation without pretending a host listener returns the action mutation's output. Core does not own the host callback type, so its host branch is deliberately unknown; framework bindings may refine it.

Parameters

invocation

ActionObservedInvocation<Output, unknown, Id>

settlement

ActionSettlementCapability<Id>

Returns

void | PromiseLike<void>


onInvocationError?

readonly optional onInvocationError?: (error) => void | PromiseLike<void>

Defined in: src/action/types.ts:374

Optional sink for observer failures; neither observer can replace app behavior.

Parameters

error

unknown

Returns

void | PromiseLike<void>

On this page