Class DeltaTimeout

Generic event emitter with typed events and methods similar to Node.js EventEmitter.

Example

const emitter = new LeaEventEmitter<{
  update: [number];
  error: [Error];
}>();

emitter.on('update', (delta) => console.log(delta));
emitter.emit('update', 0.016);

Hierarchy (View Summary)

LeaEventEmitter<{ finish: void[] }>
- DeltaTimeout

Implements

Updatable

Index

Constructors

constructor

new DeltaTimeout(__namedParameters: TimeoutConfig): DeltaTimeout
Parameters
- __namedParameters: TimeoutConfig
Returns DeltaTimeout
Overrides LeaEventEmitter.constructor
- Defined in src/lea.ts:2673

Properties

listenerMap

listenerMap: Map<"finish", Listener<any[]>[]> = ...

`Readonly`duration

duration: number

elapsed

elapsed: number

finished

finished: boolean

easing

easing: (t: number) => number

Methods

wait

wait<K extends "finish">(
event: K,
timeout?: number,
): Promise<{ finish: void[] }[K]>
Await the next emission of a specific event. Resolves with the arguments passed to that event.
Type Parameters
- K extends "finish"
Parameters
- event: K
- timeout: number = ...
Returns Promise<{ finish: void[] }[K]>
Inherited from LeaEventEmitter.wait
- Defined in src/lea.ts:38

waitAny

waitAny<K extends "finish">(
events: K[],
): Promise<{ event: K; args: { finish: void[] }[K] }>
Await the next emission of any one of the listed events. Resolves with { event: name, args: the arguments it received }
Type Parameters
- K extends "finish"
Parameters
- events: K[]
Returns Promise<{ event: K; args: { finish: void[] }[K] }>
Inherited from LeaEventEmitter.waitAny
- Defined in src/lea.ts:58

waitAll

waitAll<const K extends readonly "finish"[]>(
...events: K,
): Promise<{ [I in string | number | symbol]: { finish: void[] }[K[I<I>]] }>
Type Parameters
- const K extends readonly "finish"[]
Parameters
- ...events: K
Returns Promise<{ [I in string | number | symbol]: { finish: void[] }[K[I<I>]] }>
Inherited from LeaEventEmitter.waitAll
- Defined in src/lea.ts:74

on

on<K extends "finish">(
event: K,
listener: (...args: { finish: void[] }[K]) => void,
): this
Registers a listener for the specified event.
Type Parameters
- K extends "finish"
  Event name
Parameters
- event: K
  The name of the event
- listener: (...args: { finish: void[] }[K]) => void
  The callback to invoke when the event is emitted
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.on
- Defined in src/lea.ts:103

onWithCleanup

onWithCleanup<K extends "finish">(
event: K,
listener: (off: () => void, ...args: { finish: void[] }[K]) => void,
): () => void
Registers a listener for the specified event but returns a cleanup func.
Type Parameters
- K extends "finish"
  Event name
Parameters
- event: K
  The name of the event
- listener: (off: () => void, ...args: { finish: void[] }[K]) => void
  The callback to invoke when the event is emitted
Returns () => void
Inherited from LeaEventEmitter.onWithCleanup
- Defined in src/lea.ts:119

once

once<K extends "finish">(
event: K,
listener: (...args: { finish: void[] }[K]) => void,
): this
Registers a one-time listener for the specified event.

The listener is automatically removed after the first invocation.
Type Parameters
- K extends "finish"
  Event name
Parameters
- event: K
  The name of the event
- listener: (...args: { finish: void[] }[K]) => void
  The callback to invoke once
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.once
- Defined in src/lea.ts:142

off

off<K extends "finish">(
event: K,
listener: (...args: { finish: void[] }[K]) => void,
): this
Removes a listener for the specified event.
Type Parameters
- K extends "finish"
  Event name
Parameters
- event: K
  The name of the event
- listener: (...args: { finish: void[] }[K]) => void
  The callback to remove
Returns this
This emitter for chaining
Inherited from LeaEventEmitter.off
- Defined in src/lea.ts:162

emit

emit<K extends "finish">(event: K, ...args: { finish: void[] }[K]): boolean
Emits an event, invoking all registered listeners with the provided arguments.

If the event is "error" and no listeners are registered, the first argument (the error) will be thrown.
Type Parameters
- K extends "finish"
  Event name
Parameters
- event: K
  The name of the event to emit
- ...args: { finish: void[] }[K]
  Arguments to pass to listeners
Returns boolean
true if any listeners were invoked, false otherwise
Inherited from LeaEventEmitter.emit
- Defined in src/lea.ts:184

`Protected`emitIgnored

emitIgnored<K extends "finish">(event: K, ...args: any): boolean
Emits an event, invoking all registered listeners with the provided arguments.

If the event is "error" and no listeners are registered, the first argument (the error) will be thrown.
Type Parameters
- K extends "finish"
  Event name
Parameters
- event: K
  The name of the event to emit
- ...args: any
  Arguments to pass to listeners
Returns boolean
true if any listeners were invoked, false otherwise
Inherited from LeaEventEmitter.emitIgnored
- Defined in src/lea.ts:209

removeAllListeners

removeAllListeners<K extends "finish">(event?: K): DeltaTimeout
Removes all listeners for the specified event, or all listeners if no event is provided.
Type Parameters
- K extends "finish"
  Event name
Parameters
- Optionalevent: K
  Optional event name to clear listeners for
Returns DeltaTimeout
This emitter for chaining
Inherited from LeaEventEmitter.removeAllListeners
- Defined in src/lea.ts:234

listenerCount

listenerCount<K extends "finish">(event: K): number
Returns the number of listeners registered for the specified event.
Type Parameters
- K extends "finish"
  Event name
Parameters
- event: K
  The event to count listeners for
Returns number
The number of registered listeners
Inherited from LeaEventEmitter.listenerCount
- Defined in src/lea.ts:250

toPromise

toPromise(): Promise<unknown>
Returns Promise<unknown>
- Defined in src/lea.ts:2683

toEphermalPromise

toEphermalPromise(): EphermalPromise<unknown>
Returns EphermalPromise<unknown>
- Defined in src/lea.ts:2692

update

update(deltaSeconds: number): void
Advance tween by delta time
Parameters
- deltaSeconds: number
Returns void
Implementation of Updatable.update
- Defined in src/lea.ts:2711

Class DeltaTimeout

Example

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeltaTimeout

Properties

listenerMap

Readonlyduration

elapsed

finished

easing

Methods

wait

Type Parameters

Parameters

Returns Promise<{ finish: void[] }[K]>

waitAny

Type Parameters

Parameters

Returns Promise<{ event: K; args: { finish: void[] }[K] }>

waitAll

Type Parameters

Parameters

Returns Promise<{ [I in string | number | symbol]: { finish: void[] }[K[I<I>]] }>

on

Type Parameters

Parameters

Returns this

onWithCleanup

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns this

off

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

ProtectedemitIgnored

Type Parameters

Parameters

Returns boolean

removeAllListeners

Type Parameters

Parameters

Returns DeltaTimeout

listenerCount

Type Parameters

Parameters

Returns number

toPromise

Returns Promise<unknown>

toEphermalPromise

Returns EphermalPromise<unknown>

update

Parameters

Returns void

Settings

On This Page

`Readonly`duration

`Protected`emitIgnored