BeUiEvent<TEventArgs> Class

Specialization of BeEvent for events that take a single strongly typed argument, primarily used for UI events.

Extends

  • BeEvent<(args: TEventArgs) => void>

Methods

Name Description
constructor<TEventArgs>(): BeUiEvent<TEventArgs>    
emit(args: TEventArgs): void Raises event with single strongly typed argument.  

Inherited methods

Name Inherited from Description
addListener(listener: (args: TEventArgs) => void, scope?: any): () => void BeEvent<(args: TEventArgs) => void> Registers a Listener to be executed whenever this event is raised.
addOnce(listener: (args: TEventArgs) => void, scope?: any): () => void BeEvent<(args: TEventArgs) => void> Registers a callback function to be executed only once when the event is raised.
clear(): void BeEvent<(args: TEventArgs) => void> Clear all Listeners from this BeEvent.
has(listener: (args: TEventArgs) => void, scope?: any): boolean BeEvent<(args: TEventArgs) => void> Determine whether this BeEvent has a specified listener registered.
raiseEvent(...args: [args]): void BeEvent<(args: TEventArgs) => void> Raises the event by calling each registered listener with the supplied arguments.
removeListener(listener: (args: TEventArgs) => void, scope?: any): boolean BeEvent<(args: TEventArgs) => void> Un-register a previously registered listener.

Inherited properties

Name Type Inherited from Description
numberOfListeners Accessor ReadOnly number BeEvent<(args: TEventArgs) => void> The number of listeners currently subscribed to the event.

Defined in

Last Updated: 11 June, 2024