Skip to content

API Reference / @gtkx/runtime / emitSignal

Function: emitSignal() ​

emitSignal(instance, signal, args, returns?): unknown

Defined in: packages/runtime/src/signal.ts:533

Emits a signal on an instance with the given arguments and returns its result combined with any output-argument values.

Parameters ​

instance ​

object

Emitter to emit the signal on.

signal ​

string

Signal name, optionally including a ::detail suffix.

args ​

EmitArg[]

Arguments to pass, including output and inout arguments.

returns? ​

Descriptor

Descriptor for the signal's return value, omitted when it returns void.

Returns ​

unknown