performance-helpers 1.0.0 → 1.0.1

package/docs/helpers/powerPool/classes/PowerPoolShutdownError.md

@@ -1,67 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerPool](../README.md) / PowerPoolShutdownError
-
-# Class: PowerPoolShutdownError
-
-PowerPoolShutdownError
-
-Error thrown when the `PowerPool` is shut down and pending tasks are rejected.
-
- PowerPoolShutdownError
-
-## Extends
-
-- `Error`
-
-## Constructors
-
-### Constructor
-
-> **new PowerPoolShutdownError**(`message?`): `PowerPoolShutdownError`
-
-#### Parameters
-
-##### message?
-
-`string` = `'PowerPool has been shut down'`
-
-#### Returns
-
-`PowerPoolShutdownError`
-
-#### Overrides
-
-`Error.constructor`
-
-## Properties
-
-### message
-
-> **message**: `string`
-
-#### Inherited from
-
-`Error.message`
-
-***
-
-### name
-
-> **name**: `string`
-
-#### Inherited from
-
-`Error.name`
-
-***
-
-### stack?
-
-> `optional` **stack?**: `string`
-
-#### Inherited from
-
-`Error.stack`

package/docs/helpers/powerQueue/README.md

@@ -1,11 +0,0 @@
-[**performance-helpers**](../../README.md)
-
-***
-
-[performance-helpers](../../README.md) / helpers/powerQueue
-
-# helpers/powerQueue
-
-## Classes
-
-- [PowerQueue](classes/PowerQueue.md)

package/docs/helpers/powerQueue/classes/PowerQueue.md

@@ -1,302 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerQueue](../README.md) / PowerQueue
-
-# Class: PowerQueue
-
-PowerQueue
-
-Lightweight resizable ring-buffer queue with O(1) enqueue/dequeue.
-Designed as a small, dependency-free helper for high-throughput queues.
-
- PowerQueue
-
-## Example
-
-```ts
-const q = new PowerQueue(8);
-q.push(1);
-q.push(2);
-q.shift(); // 1
-```
-
-## Constructors
-
-### Constructor
-
-> **new PowerQueue**(`initialCapacity?`): `PowerQueue`
-
-Create a PowerQueue.
-
-#### Parameters
-
-##### initialCapacity?
-
-`number` = `16`
-
-Initial capacity (rounded up to power-of-two).
-
-#### Returns
-
-`PowerQueue`
-
-## Properties
-
-### \_buffer
-
-> **\_buffer**: `any`[]
-
-***
-
-### \_capacity
-
-> **\_capacity**: `number`
-
-***
-
-### \_head
-
-> **\_head**: `number`
-
-***
-
-### \_mask
-
-> **\_mask**: `number`
-
-***
-
-### \_size
-
-> **\_size**: `number`
-
-***
-
-### \_tail
-
-> **\_tail**: `number`
-
-## Accessors
-
-### capacity
-
-#### Get Signature
-
-> **get** **capacity**(): `number`
-
-Internal buffer capacity (always a power-of-two).
-
-##### Returns
-
-`number`
-
-***
-
-### isEmpty
-
-#### Get Signature
-
-> **get** **isEmpty**(): `boolean`
-
-Whether the queue is empty.
-
-##### Returns
-
-`boolean`
-
-***
-
-### length
-
-#### Get Signature
-
-> **get** **length**(): `number`
-
-Number of items currently queued.
-
-##### Returns
-
-`number`
-
-## Methods
-
-### \[iterator\]()
-
-> **\[iterator\]**(): `Iterator`\<`any`, `any`, `any`\>
-
-Iterator (non-destructive) yielding items in FIFO order.
-Allows `for...of` and spread (`[...queue]`) without consuming the queue.
-
-#### Returns
-
-`Iterator`\<`any`, `any`, `any`\>
-
-***
-
-### clear()
-
-> **clear**(): `void`
-
-Remove all items from the queue.
-
-#### Returns
-
-`void`
-
-***
-
-### drain()
-
-> **drain**(): `Iterator`\<`any`, `any`, `any`\>
-
-Consuming drain iterator: yields items in FIFO order and removes them
-from the queue as they are iterated.
-Useful for streaming/processing and emptying the queue without manual loops.
-
-#### Returns
-
-`Iterator`\<`any`, `any`, `any`\>
-
-***
-
-### entries()
-
-> **entries**(): `Iterator`\<\[`number`, `any`\], `any`, `any`\>
-
-Non-destructive entries iterator that yields [index, value] pairs where
-index is the zero-based position in the queue (0 is the head).
-
-#### Returns
-
-`Iterator`\<\[`number`, `any`\], `any`, `any`\>
-
-***
-
-### keys()
-
-> **keys**(): `Iterator`\<`number`, `any`, `any`\>
-
-Return an iterator of keys (zero-based indexes from the head).
-
-#### Returns
-
-`Iterator`\<`number`, `any`, `any`\>
-
-***
-
-### peek()
-
-> **peek**(): `any`
-
-Peek at the head item without removing it.
-
-#### Returns
-
-`any`
-
-The head item or `undefined` when empty.
-
-***
-
-### push()
-
-> **push**(`item`): `number`
-
-Enqueue an item at the tail.
-
-#### Parameters
-
-##### item
-
-`any`
-
-Item to enqueue.
-
-#### Returns
-
-`number`
-
-New queue length after push.
-
-***
-
-### pushMany()
-
-> **pushMany**(`items`): `number`
-
-Enqueue multiple items in one call. Optimized to resize buffer once and
-copy items in contiguous blocks when possible.
-
-#### Parameters
-
-##### items
-
-`any`[]
-
-#### Returns
-
-`number`
-
-New queue length after all pushes.
-
-***
-
-### shift()
-
-> **shift**(): `any`
-
-Dequeue and return the head item.
-
-#### Returns
-
-`any`
-
-The dequeued item or `undefined` when empty.
-
-***
-
-### toArray()
-
-> **toArray**(): `any`[]
-
-Return a shallow array snapshot of the queue contents in FIFO order.
-This is a convenience helper that does not consume the queue.
-
-#### Returns
-
-`any`[]
-
-***
-
-### unshiftMany()
-
-> **unshiftMany**(`items`): `number`
-
-Prepend multiple items to the head of the queue.
-The first element of `items` will become the next value returned by `shift()`.
-
-#### Parameters
-
-##### items
-
-`any`[]
-
-#### Returns
-
-`number`
-
-New queue length after all unshifts.
-
-***
-
-### values()
-
-> **values**(): `Iterator`\<`any`, `any`, `any`\>
-
-Return an iterator of values (alias of the default iterator).
-
-#### Returns
-
-`Iterator`\<`any`, `any`, `any`\>

package/docs/helpers/powerRateLimit/README.md

@@ -1,17 +0,0 @@
-[**performance-helpers**](../../README.md)
-
-***
-
-[performance-helpers](../../README.md) / helpers/powerRateLimit
-
-# helpers/powerRateLimit
-
-## Classes
-
-- [PowerRateLimit](classes/PowerRateLimit.md)
-
-## References
-
-### default
-
-Renames and re-exports [PowerRateLimit](classes/PowerRateLimit.md)

package/docs/helpers/powerRateLimit/classes/PowerRateLimit.md

@@ -1,187 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerRateLimit](../README.md) / PowerRateLimit
-
-# Class: PowerRateLimit
-
-PowerRateLimit
-
-Compose multiple rate limiters and provide a unified `tryConsume`/`reserve` API.
-Returns success only when all underlying limiters allow consumption.
-
- PowerRateLimit
-
-## Constructors
-
-### Constructor
-
-> **new PowerRateLimit**(`limiters?`, `options?`): `PowerRateLimit`
-
-#### Parameters
-
-##### limiters?
-
-`Object`[] = `[]`
-
-Array of limiter instances implementing
-  `tryConsume(n)` and preferably `available()`.
-
-##### options?
-
-###### atomic?
-
-`boolean`
-
-When `true` attempt to provide
-  atomic semantics: either all limiters allow consumption or none will be
-  left mutated. This requires underlying limiters to expose `available()`
-  or an undo primitive (e.g. `reserve`/`release` or `addTokens`). If a
-  safe rollback cannot be guaranteed the call will return `false`.
-
-#### Returns
-
-`PowerRateLimit`
-
-## Properties
-
-### atomicDefault
-
-> **atomicDefault**: `boolean`
-
-***
-
-### limiters
-
-> **limiters**: `Object`[]
-
-## Methods
-
-### \_undoCommit()
-
-> **\_undoCommit**(`entry`, `want`): `Promise`\<`any`\>
-
-#### Parameters
-
-##### entry
-
-`any`
-
-##### want
-
-`any`
-
-#### Returns
-
-`Promise`\<`any`\>
-
-***
-
-### available()
-
-> **available**(): `number`
-
-Return the minimum available tokens across all limiters.
-If any limiter does not expose `available()`, this returns `0`.
-
-#### Returns
-
-`number`
-
-***
-
-### release()
-
-> **release**(`tokenOrN`): `void`
-
-Release a prior reservation token or numeric count back to the limiters.
-This accepts the same token object produced by `reserve()` or a numeric
-count to return tokens directly.
-
-#### Parameters
-
-##### tokenOrN
-
-`number` \| `object`
-
-#### Returns
-
-`void`
-
-***
-
-### reserve()
-
-> **reserve**(`n?`): \{ `n`: `number`; \} \| `null`
-
-Reserve `n` tokens across all limiters and return a token to undo later.
-Returns `null` when reservation fails.
-The returned token is a simple marker object such as `{ n: 1 }`, and it can
-be consumed by `release(token)` or `rollback(token)` to restore the limiters.
-
-#### Parameters
-
-##### n?
-
-`number` = `1`
-
-#### Returns
-
-\{ `n`: `number`; \} \| `null`
-
-***
-
-### reset()
-
-> **reset**(): `void`
-
-Reset all underlying limiters where supported.
-
-#### Returns
-
-`void`
-
-***
-
-### rollback()
-
-> **rollback**(`nOrToken`): `void`
-
-#### Parameters
-
-##### nOrToken
-
-`any`
-
-#### Returns
-
-`void`
-
-***
-
-### tryConsume()
-
-> **tryConsume**(`n?`, `options?`): `boolean`
-
-Try to consume `n` tokens across all limiters. Returns true only when
-every underlying limiter allows consumption. This method first performs
-a non-mutating availability check when `available()` is present; if all
-checks pass it then performs the actual `tryConsume` calls to commit.
-
-Note: when a limiter does not implement `available()` this method falls
-back to calling `tryConsume` directly which may partially mutate state
-if other limiters subsequently fail. Prefer limiters that implement
-`available()` for atomic semantics.
-
-#### Parameters
-
-##### n?
-
-`number` = `1`
-
-##### options?
-
-#### Returns
-
-`boolean`

package/docs/helpers/powerRetry/README.md

@@ -1,23 +0,0 @@
-[**performance-helpers**](../../README.md)
-
-***
-
-[performance-helpers](../../README.md) / helpers/powerRetry
-
-# helpers/powerRetry
-
-## Classes
-
-- [PowerRetry](classes/PowerRetry.md)
-
-## References
-
-### default
-
-Renames and re-exports [PowerRetry](classes/PowerRetry.md)
-
-***
-
-### PowerRetryOptions
-
-Re-exports [PowerRetryOptions](../jsdoc-types/interfaces/PowerRetryOptions.md)

package/docs/helpers/powerRetry/classes/PowerRetry.md

@@ -1,106 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerRetry](../README.md) / PowerRetry
-
-# Class: PowerRetry
-
-Retry helper with configurable backoff and jitter.
-
- PowerRetry
-
-## Example
-
-```ts
-const retry = new PowerRetry({ maxAttempts: 4, baseDelay: 50 });
-const data = await retry.run(() => fetch('/api/data'));
-```
-
-## Constructors
-
-### Constructor
-
-> **new PowerRetry**(`options?`): `PowerRetry`
-
-Run a function with retry/backoff semantics.
-Create a configured retry helper.
-
-#### Parameters
-
-##### options?
-
-[`PowerRetryOptions`](../../jsdoc-types/interfaces/PowerRetryOptions.md) = `{}`
-
-Default options applied to every `run()` invocation.
-
-#### Returns
-
-`PowerRetry`
-
-## Properties
-
-### \_options
-
-> **\_options**: [`PowerRetryOptions`](../../jsdoc-types/interfaces/PowerRetryOptions.md)
-
-## Methods
-
-### run()
-
-> **run**(`fn`, `options?`): `Promise`\<`any`\>
-
-Instance method that runs `fn` with the configured options merged with
-any per-call `options` provided.
-
-#### Parameters
-
-##### fn
-
-`Function`
-
-Async function to execute.
-
-##### options?
-
-[`PowerRetryOptions`](../../jsdoc-types/interfaces/PowerRetryOptions.md) = `{}`
-
-Per-call retry overrides.
-
-#### Returns
-
-`Promise`\<`any`\>
-
-Resolves with `fn` result, rejects with final attempt error.
-
-***
-
-### run()
-
-> `static` **run**(`fn`, `options?`): `Promise`\<`any`\>
-
-Execute a function with retry/backoff semantics.
-
-#### Parameters
-
-##### fn
-
-`Function`
-
-Async function to execute.
-
-##### options?
-
-[`PowerRetryOptions`](../../jsdoc-types/interfaces/PowerRetryOptions.md) = `{}`
-
-Retry behavior overrides for this invocation.
-
-#### Returns
-
-`Promise`\<`any`\>
-
-Resolves with `fn` result, rejects with final attempt error.
-
-#### Throws
-
-When `fn` is not callable or `maxAttempts` is not a positive finite number.

package/docs/helpers/powerScheduler/README.md

@@ -1,11 +0,0 @@
-[**performance-helpers**](../../README.md)
-
-***
-
-[performance-helpers](../../README.md) / helpers/powerScheduler
-
-# helpers/powerScheduler
-
-## Classes
-
-- [PowerScheduler](classes/PowerScheduler.md)