Skip to content

Class: FFZWaitableEvent<TData, TReturn>

utilities/events.FFZWaitableEvent

Type parameters

NameType
TDataTData
TReturnvoid

Hierarchy

Constructors

constructor

new FFZWaitableEvent<TData, TReturn>(data): FFZWaitableEvent<TData, TReturn>

Type parameters

NameType
TDataTData
TReturnvoid

Parameters

NameType
dataTData

Returns

FFZWaitableEvent<TData, TReturn>

Inherited from

FFZEvent.constructor

Defined in

src/utilities/events.ts:397

Methods

_reset

_reset(): void

Returns

void

Overrides

FFZEvent._reset

Defined in

src/utilities/events.ts:457


_wait

_wait(): void | Promise<TReturn[]>

Returns

void | Promise<TReturn[]>

Defined in

src/utilities/events.ts:441


preventDefault

preventDefault(): void

Returns

void

Inherited from

FFZEvent.preventDefault

Defined in

src/utilities/events.ts:413


stopPropagation

stopPropagation(): void

Returns

void

Inherited from

FFZEvent.stopPropagation

Defined in

src/utilities/events.ts:409


waitFor

waitFor(promise): void

Parameters

NameType
promisePromise<TReturn>

Returns

void

Defined in

src/utilities/events.ts:463


makeEvent

makeEvent<TData, TReturn>(data): TypedFFZWaitableEvent<TData, TReturn>

Create a new FFZWaitableEvent with proper type inheritence from the supplied data. This should always be used to construct an event instance, rather than creating the event manually.

Type parameters

NameType
TDataextends Record<string, any> = {}
TReturnvoid

Parameters

NameType
dataTData

Returns

TypedFFZWaitableEvent<TData, TReturn>

Overrides

FFZEvent.makeEvent

Defined in

src/utilities/events.ts:434