hacifootprint
hcifootprintFunctions

connectAction

Function: connectAction()

Call Signature

connectAction<F, Id, Mode>(runtime, definition, options): ActionConnection<F, Id, true, Mode>

Defined in: src/action/connection.ts:138

Connect one stable live binding of an already-declared callable action.

Type Parameters

F

F extends (...args) => any

Id

Id extends string

Mode

Mode extends ActionInvocationMode

Parameters

runtime

ActionRuntime

Isolated owner of bindings, offers, and transitions.

definition

DefinedAction<F, Id, Mode>

Exact callable returned by defineAction().

options

Mode extends "scalar" ? ConnectActionOptions<Parameters<F>[0], Awaited<ReturnType<F>>, Id> & object : never

Always requires node. The overload returning an input-reader connection is scalar-only and requires input: () => payload; inputless and host definitions forbid that reader.

Returns

ActionConnection<F, Id, true, Mode>

Call Signature

connectAction<F, Id, Mode>(runtime, definition, options): ActionConnection<F, Id, false, Mode>

Defined in: src/action/connection.ts:151

Connect one stable live binding of an already-declared callable action.

Type Parameters

F

F extends (...args) => any

Id

Id extends string

Mode

Mode extends ActionInvocationMode

Parameters

runtime

ActionRuntime

Isolated owner of bindings, offers, and transitions.

definition

DefinedAction<F, Id, Mode>

Exact callable returned by defineAction().

options

Omit<ConnectActionOptions<Mode extends "scalar" ? Parameters<F>[0] : undefined, Awaited<ReturnType<F>>, Id>, "input"> & object

Always requires node. The overload returning an input-reader connection is scalar-only and requires input: () => payload; inputless and host definitions forbid that reader.

Returns

ActionConnection<F, Id, false, Mode>

On this page