npm - @kayelaa/canvas - Versions diffs - 0.1.13 → 0.1.14 - Mend

@kayelaa/canvas 0.1.13 → 0.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (136) hide show

package/docs/@kayelaa/namespaces/LEA/classes/LeaTimeout.md DELETED Viewed

@@ -1,490 +0,0 @@
-[**@kayelaa/canvas**](../../../../README.md)
-***
-[@kayelaa/canvas](../../../../README.md) / [LEA](../README.md) / LeaTimeout
-# Class: LeaTimeout
-Defined in: [lea.ts:1645](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1645)
-Generic event emitter with typed events and methods similar to Node.js EventEmitter.
-## Example
-```ts
-const emitter = new LeaEventEmitter<{
-  update: [number];
-  error: [Error];
-}>();
-emitter.on('update', (delta) => console.log(delta));
-emitter.emit('update', 0.016);
-```
-## Extends
-- [`LeaEventEmitter`](LeaEventEmitter.md)\<\{ `finish`: \[`void`\]; \}\>
-## Constructors
-### Constructor
-> **new LeaTimeout**(`duration`, `ticker`): `LeaTimeout`
-Defined in: [lea.ts:1657](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1657)
-#### Parameters
-##### duration
-`number`
-Duration in milliseconds
-##### ticker
-[`LeaTickerII`](LeaTickerII.md) = `null`
-Optional ticker to drive the timeout
-#### Returns
-`LeaTimeout`
-#### Overrides
-[`LeaEventEmitter`](LeaEventEmitter.md).[`constructor`](LeaEventEmitter.md#constructor)
-## Properties
-### duration
-> **duration**: `number`
-Defined in: [lea.ts:1646](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1646)
-***
-### ticker
-> **ticker**: [`LeaTickerII`](LeaTickerII.md)
-Defined in: [lea.ts:1647](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1647)
-***
-### elapsed
-> **elapsed**: `number`
-Defined in: [lea.ts:1648](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1648)
-***
-### finished
-> **finished**: `boolean`
-Defined in: [lea.ts:1649](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1649)
-***
-### \_resolve()
-> **\_resolve**: (`value?`) => `void`
-Defined in: [lea.ts:1650](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1650)
-#### Parameters
-##### value?
-`unknown`
-#### Returns
-`void`
-***
-### promise
-> **promise**: `Promise`\<`unknown`\>
-Defined in: [lea.ts:1651](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1651)
-***
-### \_timeoutId
-> **\_timeoutId**: `Timeout`
-Defined in: [lea.ts:1652](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1652)
-## Methods
-### on()
-> **on**\<`K`\>(`event`, `listener`): `this`
-Defined in: [lea.ts:38](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L38)
-Registers a listener for the specified event.
-#### Type Parameters
-##### K
-`K` *extends* `"finish"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event
-##### listener
-(...`args`) => `void`
-The callback to invoke when the event is emitted
-#### Returns
-`this`
-This emitter for chaining
-#### Inherited from
-[`LeaEventEmitter`](LeaEventEmitter.md).[`on`](LeaEventEmitter.md#on)
-***
-### once()
-> **once**\<`K`\>(`event`, `listener`): `this`
-Defined in: [lea.ts:58](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L58)
-Registers a one-time listener for the specified event.
-The listener is automatically removed after the first invocation.
-#### Type Parameters
-##### K
-`K` *extends* `"finish"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event
-##### listener
-(...`args`) => `void`
-The callback to invoke once
-#### Returns
-`this`
-This emitter for chaining
-#### Inherited from
-[`LeaEventEmitter`](LeaEventEmitter.md).[`once`](LeaEventEmitter.md#once)
-***
-### off()
-> **off**\<`K`\>(`event`, `listener`): `this`
-Defined in: [lea.ts:78](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L78)
-Removes a listener for the specified event.
-#### Type Parameters
-##### K
-`K` *extends* `"finish"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event
-##### listener
-(...`args`) => `void`
-The callback to remove
-#### Returns
-`this`
-This emitter for chaining
-#### Inherited from
-[`LeaEventEmitter`](LeaEventEmitter.md).[`off`](LeaEventEmitter.md#off)
-***
-### emit()
-> **emit**\<`K`\>(`event`, ...`args`): `boolean`
-Defined in: [lea.ts:100](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L100)
-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
-`K` *extends* `"finish"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event to emit
-##### args
-...`object`\[`K`\]
-Arguments to pass to listeners
-#### Returns
-`boolean`
-`true` if any listeners were invoked, `false` otherwise
-#### Inherited from
-[`LeaEventEmitter`](LeaEventEmitter.md).[`emit`](LeaEventEmitter.md#emit)
-***
-### removeAllListeners()
-> **removeAllListeners**\<`K`\>(`event?`): `LeaTimeout`
-Defined in: [lea.ts:119](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L119)
-Removes all listeners for the specified event, or all listeners if no event is provided.
-#### Type Parameters
-##### K
-`K` *extends* `"finish"`
-Event name
-#### Parameters
-##### event?
-`K`
-Optional event name to clear listeners for
-#### Returns
-`LeaTimeout`
-This emitter for chaining
-#### Inherited from
-[`LeaEventEmitter`](LeaEventEmitter.md).[`removeAllListeners`](LeaEventEmitter.md#removealllisteners)
-***
-### listenerCount()
-> **listenerCount**\<`K`\>(`event`): `number`
-Defined in: [lea.ts:135](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L135)
-Returns the number of listeners registered for the specified event.
-#### Type Parameters
-##### K
-`K` *extends* `"finish"`
-Event name
-#### Parameters
-##### event
-`K`
-The event to count listeners for
-#### Returns
-`number`
-The number of registered listeners
-#### Inherited from
-[`LeaEventEmitter`](LeaEventEmitter.md).[`listenerCount`](LeaEventEmitter.md#listenercount)
-***
-### update()
-> **update**(`delta`): `void`
-Defined in: [lea.ts:1672](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1672)
-#### Parameters
-##### delta
-`number` = `0`
-#### Returns
-`void`
-***
-### finish()
-> **finish**(): `void`
-Defined in: [lea.ts:1680](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1680)
-#### Returns
-`void`
-***
-### start()
-> **start**(): `LeaTimeout`
-Defined in: [lea.ts:1691](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1691)
-Start the timeout manually if no ticker is provided
-#### Returns
-`LeaTimeout`
-***
-### cancel()
-> **cancel**(): `void`
-Defined in: [lea.ts:1701](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1701)
-Cancel the timeout
-#### Returns
-`void`
-***
-### then()
-> **then**\<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`\<`TResult1` \| `TResult2`\>
-Defined in: [lea.ts:1710](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1710)
-#### Type Parameters
-##### TResult1
-`TResult1` = `unknown`
-##### TResult2
-`TResult2` = `never`
-#### Parameters
-##### onfulfilled?
-(`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\>
-##### onrejected?
-(`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\>
-#### Returns
-`Promise`\<`TResult1` \| `TResult2`\>
-***
-### after()
-> **after**\<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`\<`TResult1` \| `TResult2`\>
-Defined in: [lea.ts:1725](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1725)
-#### Type Parameters
-##### TResult1
-`TResult1` = `unknown`
-##### TResult2
-`TResult2` = `never`
-#### Parameters
-##### onfulfilled?
-(`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\>
-##### onrejected?
-(`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\>
-#### Returns
-`Promise`\<`TResult1` \| `TResult2`\>