Interface EventedList<T, M>

List of generic items which can dispatch events.

interface EventedList<T, M extends EventMap<StringKeyOf<M>>> {
    length: number;
    addEventListener<TType extends string>(
        type: TType | readonly TType[],
        listener: EventListener<M[TType]>,
    ): void;
    item(index: number): undefined | T;
    removeEventListener<TType extends string>(
        type: TType | readonly TType[],
        listener: EventListener<M[TType]>,
    ): void;
    [index: number]: T;
}

Type Parameters

T
M extends EventMap<StringKeyOf<M>>

Hierarchy (View Summary)

List<T>
EventDispatcher<M>
- EventedList

Indexable

[index: number]: T
The object representing the nth in the list.

Index

Properties

Methods

addEventListener item removeEventListener

Properties

length

length: number

The number of items in the list.

Methods

addEventListener

addEventListener<TType extends string>(
type: TType | readonly TType[],
listener: EventListener<M[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends string
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<M[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

item

item(index: number): undefined | T
Returns the object representing the nth item in the list.
Parameters
- index: number
  The index of the item to retrieve.
Returns undefined | T
Inherited from List.item

removeEventListener

removeEventListener<TType extends string>(
type: TType | readonly TType[],
listener: EventListener<M[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends string
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<M[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener