API Reference / @gtkx/navigation / EventEmitter

Type Alias: EventEmitter<EventMap>

EventEmitter<EventMap> = object

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:237

Type Parameters

EventMap

EventMap extends EventMapBase

Methods

emit()

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

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:246

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"]>