API Reference / @gtkx/runtime / onSignal

Function: onSignal()

onSignal(instance, signal, handler, isAfter?): void

Defined in: packages/runtime/src/listeners.ts:92

Connects a handler to a signal and tracks it so it can later be removed with offSignal.

Parameters

instance

object

The object emitting the signal.

signal

string

The signal name to connect to.

handler

SignalHandler

The callback invoked on each emission.

isAfter?

boolean

When true, run the handler after the default handler.

Returns

void