Interface IEvent<D>

This interface is the base to all events. All events (both internal or external) need to implement it.

Export

Interface

IEvent

Type Parameters

D

this will the type of Data to be passed, by default to the handlers.

Hierarchy-Diagram

UML class diagram of IEvent

Legend

icon for an abstract class in the UML class diagram

abstract class

icon for an interface in the UML class diagram

interface

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

Hierarchy

IEvent

Implemented by

AbstractEvent

Index

Methods

addHandler hasHandlers removeHandler trigger

Methods

addHandler

addHandler(handler: OSGeneric, ...args: any[]): void
Parameters
- handler: OSGeneric
- Rest ...args: any[]
Returns void
- Defined in OSFramework/Event/IEvent.ts:12

hasHandlers

hasHandlers(): boolean
Returns boolean
- Defined in OSFramework/Event/IEvent.ts:13

removeHandler

removeHandler(handler: OSGeneric): void
Parameters
- handler: OSGeneric
Returns void
- Defined in OSFramework/Event/IEvent.ts:14

trigger

trigger(data: D, ...args: unknown[]): unknown
Parameters
- data: D
- Rest ...args: unknown[]
Returns unknown
- Defined in OSFramework/Event/IEvent.ts:15