Class ShimiEvent<TData, TSource>

The base event class in shimi.

Type Parameters

TData extends ShimiEventData<TSource>
TSource

Hierarchy

ShimiEvent
Hierarchy

Index

Constructors

Accessors

Methods

add remove trigger

Constructors

constructor

new ShimiEvent<TData, TSource>(): ShimiEvent<TData, TSource>
Type Parameters
Type Parameters
- TData extends ShimiEventData<TSource>
- TSource
Returns ShimiEvent<TData, TSource>

Accessors

handlers

get handlers(): ShimiHandler<TData, TSource>[]
A collection of handlers which get called in order when the event is triggered.

Returns ShimiHandler<TData, TSource>[]
- Defined in ShimiEvent.ts:21

Methods

add

add(handler: ShimiHandler<TData, TSource> | ((data: TData) => void)): ShimiHandler<TData, TSource>
Add a new handler to the event.

Returns
Returns the added ShimiHandler object.
Parameters
- handler: ShimiHandler<TData, TSource> | ((data: TData) => void)
  
  The new handler, either as a function, or a ShimiHandler object.
Returns ShimiHandler<TData, TSource>
- Defined in ShimiEvent.ts:29

remove

remove(where: ((handler: ShimiHandler<TData, TSource>) => boolean)): void
Remove the specified handlers from the event.
Parameters
- where: ((handler: ShimiHandler<TData, TSource>) => boolean)
  - - (handler: ShimiHandler<TData, TSource>): boolean
    - Parameters
      
      handler: ShimiHandler<TData, TSource>
      
      Returns boolean
Returns void
- Defined in ShimiEvent.ts:44

trigger

trigger(data: TData): void
Runs the collection of handlers that have been added to the event.
Parameters
- data: TData
Returns void
- Defined in ShimiEvent.ts:49

Generated using TypeDoc