GTKX

API Reference / @gtkx/navigation / EventEmitter

Type Alias: EventEmitter<EventMap> ​

EventEmitter<EventMap> = object

Type Parameters ​

EventMap ​

EventMap extends EventMapBase

Methods ​

emit() ​

emit<EventName>(options): EventArg<EventName, EventMap[EventName]["canPreventDefault"], EventMap[EventName]["data"]>

Emit an event to child screens.

Type Parameters ​

EventName ​

EventName extends string

Parameters ​

options ​

object & EventMap[EventName]["canPreventDefault"] extends true ? object : object & undefined extends EventMap[EventName]["data"] ? object : object

Returns ​

EventArg<EventName, EventMap[EventName]["canPreventDefault"], EventMap[EventName]["data"]>