Interface IEvents

interface IEvents {
    Add<T>(eventname: string, info?: IEventInfo): IEvent<T>;
    AddListener<T>(
        eventname: string,
        listener: (eventdata: T) => void,
        onlyonce?: boolean,
    ): void;
    AddManual<T>(eventname: string, info?: IEventInfo): IManualEvent<T>;
    Fire<T>(eventname: string, eventdata: T, safe?: boolean): void;
    GetEvent<T>(eventname: string): IEvent<T>;
    GetEventData<T>(eventname: string): T;
    GetInfo(eventname: string): IEventInfo;
    GetManualEvent<T>(eventname: string): IManualEvent<T>;
    IsSignaled(eventname: string): boolean;
    List(): string[];
    Remove(eventname: string): void;
    RemoveListener<T>(
        eventname: string,
        listener: (eventdata: T) => void,
    ): void;
    Reset(eventname: string): void;
    When<T>(eventname: string, then: (eventdata: T) => void): void;
}

Index

Methods

Add AddListener AddManual Fire GetEvent GetEventData GetInfo GetManualEvent IsSignaled List Remove RemoveListener Reset When

Methods

Add

Add<T>(eventname: string, info?: IEventInfo): IEvent<T>
Create an event in the instance and return the event handle.
Type Parameters
- T
Parameters
- eventname: string
  The name of the event (should be unique in the class)
- Optionalinfo: IEventInfo
  Event attributes
Returns IEvent<T>
- Defined in mia/ts/client/events.ts:11

AddListener

AddListener<T>(
    eventname: string,
    listener: (eventdata: T) => void,
    onlyonce?: boolean,
): void
Add a listener for named event.
Type Parameters
- T
Parameters
- eventname: string
  The event name
- listener: (eventdata: T) => void
  The event listener
- Optionalonlyonce: boolean
  Automatically remove listener once called for the first time.
Returns void
- Defined in mia/ts/client/events.ts:25

AddManual

AddManual<T>(eventname: string, info?: IEventInfo): IManualEvent<T>
Create a manual reset event in the instance and return the event handle. The event will remain in signaled state after triggered until Reset is called. Listener callbacks added when the event is in signaled state, will be run immediately.
Type Parameters
- T
Parameters
- eventname: string
  The name of the event (should be unique in the class)
- Optionalinfo: IEventInfo
  Event attributes
Returns IManualEvent<T>
- Defined in mia/ts/client/events.ts:18

Fire

Fire<T>(eventname: string, eventdata: T, safe?: boolean): void
Signal the named event.
Type Parameters
- T
Parameters
- eventname: string
  The event name
- eventdata: T
  The event data passed on to the listeners
- Optionalsafe: boolean
  Catch unhandled exceptions from individual listeners
Returns void
- Defined in mia/ts/client/events.ts:32

GetEvent

GetEvent<T>(eventname: string): IEvent<T>
Get the event handle for an event.
Type Parameters
- T
Parameters
- eventname: string
  The event name
Returns IEvent<T>
- Defined in mia/ts/client/events.ts:37

GetEventData

GetEventData<T>(eventname: string): T
Get the Manual Reset event data or null if the event is not in signaled state.
Type Parameters
- T
Parameters
- eventname: string
  The event name
Returns T
- Defined in mia/ts/client/events.ts:42

GetInfo

GetInfo(eventname: string): IEventInfo
Get event info for the named event.
Parameters
- eventname: string
  The event name
Returns IEventInfo
- Defined in mia/ts/client/events.ts:47

GetManualEvent

GetManualEvent<T>(eventname: string): IManualEvent<T>
Get the event handle for a manual reset event.
Type Parameters
- T
Parameters
- eventname: string
  The event name
Returns IManualEvent<T>
- Defined in mia/ts/client/events.ts:52

IsSignaled

IsSignaled(eventname: string): boolean
Is the Manual Reset event in signaled state.
Parameters
- eventname: string
  The event name
Returns boolean
- Defined in mia/ts/client/events.ts:57

List

List(): string[]
List event names in order of appearance.

Returns string[]
- Defined in mia/ts/client/events.ts:81

Remove

Remove(eventname: string): void
Remove event from the instance.
Parameters
- eventname: string
  The event name
Returns void
- Defined in mia/ts/client/events.ts:62

RemoveListener

RemoveListener<T>(eventname: string, listener: (eventdata: T) => void): void
Remove listener for the name event.
Type Parameters
- T
Parameters
- eventname: string
  The event name
- listener: (eventdata: T) => void
  The event listener
Returns void
- Defined in mia/ts/client/events.ts:68

Reset

Reset(eventname: string): void
Reset the named Manual Reset event to unsignaled state.
Parameters
- eventname: string
  The event name of the Manual Reset event
Returns void
- Defined in mia/ts/client/events.ts:73

When

When<T>(eventname: string, then: (eventdata: T) => void): void
Listen to the named event once. (The listener is automatically removed once triggered for the first time.)
Type Parameters
- T
Parameters
- eventname: string
  The event name
- then: (eventdata: T) => void
  The listener callback
Returns void
- Defined in mia/ts/client/events.ts:79

Interface IEvents

Index

Methods

Methods

Add

Type Parameters

Parameters

Returns IEvent<T>

AddListener

Type Parameters

Parameters

Returns void

AddManual

Type Parameters

Parameters

Returns IManualEvent<T>

Fire

Type Parameters

Parameters

Returns void

GetEvent

Type Parameters

Parameters

Returns IEvent<T>

GetEventData

Type Parameters

Parameters

Returns T

GetInfo

Parameters

Returns IEventInfo

GetManualEvent

Type Parameters

Parameters

Returns IManualEvent<T>

IsSignaled

Parameters

Returns boolean

List

Returns string[]

Remove

Parameters

Returns void

RemoveListener

Type Parameters

Parameters

Returns void

Reset

Parameters

Returns void

When

Type Parameters

Parameters

Returns void

Settings

On This Page