Class DataEntity<D, E>`Abstract`

Type Parameters

D
E extends { updated: string[] } = { updated: string[] }

Hierarchy (View Summary)

TypedEventEmitter<E>
- DataEntity

Index

Constructors

Properties

Methods

emit off on once toJSON

Constructors

constructor

new DataEntity<D, E extends { updated: string[] } = { updated: string[] }>(
data: D,
): DataEntity<D, E>
Type Parameters
- D
- E extends { updated: string[] } = { updated: string[] }
Parameters
- data: D
Returns DataEntity<D, E>
Overrides TypedEventEmitter.constructor
- Defined in lib/DataEntity.ts:14

Properties

`Protected`data

data: D

`Protected`listeners

listeners: { [K in string | number | symbol]?: (data: E[K]) => void[] } = {}

Methods

`Protected`emit

emit<T extends string | number | symbol>(event: T, data: E[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- data: E[T]
Returns void
Inherited from TypedEventEmitter.emit
- Defined in lib/TypedEventEmitter.ts:57

off

off<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns void
Inherited from TypedEventEmitter.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns () => void
Inherited from TypedEventEmitter.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns () => void
Inherited from TypedEventEmitter.once
- Defined in lib/TypedEventEmitter.ts:32

toJSON

toJSON(): D
Get a copy of the entity's data

Returns D
- Defined in lib/DataEntity.ts:33