Skip to content

API Reference / @gtkx/runtime / onSignal

Function: onSignal()

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

Defined in: runtime/dist/listeners.d.ts:15

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

Parameters

instance

SignalConnectable

The object emitting the signal.

signal

string

The signal name to connect to.

handler

SignalHandler

The callback invoked on each emission.

after?

boolean

When true, run the handler after the default handler.

Returns

void

Released under the MPL-2.0 License.