Lynx

lynx-testing-environment / GlobalEventEmitter

Class: GlobalEventEmitter

The Lynx GlobalEventEmitter module, accessible via lynx.getJSModule('GlobalEventEmitter').

Framework testing libraries can use this to trigger and listen to cross-thread events.

Constructors

new GlobalEventEmitter()

new GlobalEventEmitter(): GlobalEventEmitter

Returns

GlobalEventEmitter

Properties

listeners

listeners: Record<string, Function[]>;

Defined in

lynx/GlobalEventEmitter.d.ts:9

Methods

addListener()

addListener(eventName: string, listener: Function): void

Parameters

ParameterType
eventNamestring
listenerFunction

Returns

void

Defined in

lynx/GlobalEventEmitter.d.ts:10


clear()

clear(): void

Returns

void

Defined in

lynx/GlobalEventEmitter.d.ts:13


emit()

emit(eventName: string, args: any[]): void

Parameters

ParameterType
eventNamestring
argsany[]

Returns

void

Defined in

lynx/GlobalEventEmitter.d.ts:12


removeAllListeners()

removeAllListeners(eventName?: string): void

Parameters

ParameterType
eventName?string

Returns

void

Defined in

lynx/GlobalEventEmitter.d.ts:14


removeListener()

removeListener(eventName: string, listener: Function): void

Parameters

ParameterType
eventNamestring
listenerFunction

Returns

void

Defined in

lynx/GlobalEventEmitter.d.ts:11


toggle()

toggle(eventName: string, ...data: unknown[]): void

Parameters

ParameterType
eventNamestring
...dataunknown[]

Returns

void

Defined in

lynx/GlobalEventEmitter.d.ts:16


trigger()

trigger(eventName: string, params: string | Record<any, any>): void

Parameters

ParameterType
eventNamestring
paramsstring | Record<any, any>

Returns

void

Defined in

lynx/GlobalEventEmitter.d.ts:15

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.