performance-helpers 1.0.0 → 1.0.1

package/docs/helpers/powerCache/classes/PowerMemoizer.md

@@ -1,244 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerCache](../README.md) / PowerMemoizer
-
-# Class: PowerMemoizer
-
-PowerMemoizer
-
-A small memoization wrapper backed by `PowerCache`.
-It memoizes synchronous values and Promise-returning functions.
-Concurrent calls for the same arguments are deduplicated (single inflight Promise).
-Rejected Promises are not cached.
-
-Usage (constructor returns a `PowerMemoizer` instance; when a function is supplied
-the instance creates a memoized wrapper and exposes a convenience `run()` alias):
-const fetcher = async (id) => await fetchData(id)
-const pm = new PowerMemoizer(fetcher, { cacheOptions: { defaultTTL: 1000 } })
-// call the memoized function via the convenience alias
-await pm.run(1)
-
- PowerMemoizer
-
-## Constructors
-
-### Constructor
-
-> **new PowerMemoizer**(`fn?`, `options?`): `PowerMemoizer`
-
-Create a PowerMemoizer.
-
-#### Parameters
-
-##### fn?
-
-`Function`
-
-Optional function to memoize immediately.
-
-##### options?
-
-###### cacheOptions?
-
-`Object`
-
-Options forwarded to the underlying `PowerCache` constructor. Supported keys: `maxEntries` (number), `maxWeight` (number), `weightFn` (function(value):number), `defaultTTL` (number, ms), `maxPoolSize` (number), `rejectOversized` (boolean), `onEvict` (function(key, value, reason)), `onExpire` (function(key, value)), `initialPoolSize` (number), `maxCleanupPerTick` (number). See `PowerCache` constructor JSDoc for details.
-
-###### keyResolver?
-
-(`arg0`) => `string`
-
-Function that maps the wrapped call args to a cache key. Defaults to `JSON.stringify` on args.
-  Note: `JSON.stringify(args)` is convenient but can be expensive for large or deeply-nested
-  arguments. If the wrapped function is on a hot path, provide a custom `keyResolver`
-  that cheaply and deterministically maps arguments to keys (for example, join simple
-  scalar args with a separator or use a fast hashing function).
-
-###### ttl?
-
-`number`
-
-Default TTL (ms) used when constructing the memoized wrapper for `fn`.
-
-###### weight?
-
-`number`
-
-Default weight used when constructing the memoized wrapper for `fn`.
-
-#### Returns
-
-`PowerMemoizer`
-
-## Properties
-
-### \_defaultMemoizeOptions
-
-> **\_defaultMemoizeOptions**: `object`
-
-***
-
-### \_fnWrapper
-
-> **\_fnWrapper**: `Function` \| `undefined`
-
-***
-
-### \_inflight
-
-> **\_inflight**: `Map`\<`any`, `any`\>
-
-***
-
-### \_originalFn
-
-> **\_originalFn**: `Function` \| `null`
-
-***
-
-### cache
-
-> **cache**: [`PowerCache`](PowerCache.md)
-
-***
-
-### keyResolver
-
-> **keyResolver**: (`arg0`) => `string`
-
-#### Parameters
-
-##### arg0
-
-`any`[]
-
-#### Returns
-
-`string`
-
-***
-
-### run
-
-> **run**: (...`args`) => `any`
-
-#### Parameters
-
-##### args
-
-...`any`[]
-
-#### Returns
-
-`any`
-
-## Methods
-
-### clear()
-
-> **clear**(): `void`
-
-Clear all cached entries and any inflight markers.
-
-#### Returns
-
-`void`
-
-***
-
-### delete()
-
-> **delete**(...`args`): `boolean`
-
-Delete the cached entry for the given call args.
-Also clears any inflight Promise for the key.
-
-#### Parameters
-
-##### args
-
-...`any`[]
-
-#### Returns
-
-`boolean`
-
-***
-
-### get()
-
-> **get**(...`args`): `any`
-
-Retrieve a cached value for the given call args (if present).
-
-#### Parameters
-
-##### args
-
-...`any`[]
-
-#### Returns
-
-`any`
-
-***
-
-### has()
-
-> **has**(...`args`): `boolean`
-
-Check presence for the given call args.
-
-#### Parameters
-
-##### args
-
-...`any`[]
-
-#### Returns
-
-`boolean`
-
-***
-
-### memoize()
-
-> **memoize**(`fn`, `options?`): `Function`
-
-Public API to memoize an arbitrary function using this PowerMemoizer instance's cache.
-Mirrors the behavior used by the constructor when a function is supplied —
-returns a callable memoized function with helpers attached (`get`, `has`, `delete`, `clear`, `stats`, `cache`).
-
-#### Parameters
-
-##### fn
-
-`Function`
-
-Function to memoize
-
-##### options?
-
-`Object` = `{}`
-
-Optional per-wrapper options { ttl, weight }
-
-#### Returns
-
-`Function`
-
-Memoized function
-
-***
-
-### stats()
-
-> **stats**(): `Object`
-
-Expose underlying cache stats.
-
-#### Returns
-
-`Object`

package/docs/helpers/powerCache/classes/PowerTimedCache.md

@@ -1,302 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerCache](../README.md) / PowerTimedCache
-
-# Class: PowerTimedCache
-
-PowerTimedCache
-
-A thin convenience wrapper around `PowerCache` for the common pure-TTL
-use-case. It constructs an internal `PowerCache` with the provided `ttl`
-used as the cache `defaultTTL` and automatically starts the periodic
-cleanup loop. The wrapper delegates common cache methods to the
-underlying `PowerCache` instance.
-
-## Example
-
-```ts
-const timed = new PowerTimedCache(60000, { maxEntries: 100, interval: 10000 });
-timed.set('k', 1);
-// entries will be automatically expired by the background cleaner
-
-@class PowerTimedCache
-@public
-```
-
-## Indexable
-
-> \[`key`: `number`\]: () => `void`
-
-## Constructors
-
-### Constructor
-
-> **new PowerTimedCache**(`ttl`, `options?`): `PowerTimedCache`
-
-#### Parameters
-
-##### ttl
-
-`number`
-
-Default TTL in milliseconds for entries.
-
-##### options?
-
-###### cacheOptions?
-
-`Object` = `{}`
-
-Additional options forwarded to `PowerCache`.
-
-###### interval?
-
-`number`
-
-Cleanup interval (ms) for automatic cleanup.
-
-###### maxCleanupPerTick?
-
-`number`
-
-Max nodes scanned per cleanup tick.
-
-###### maxEntries?
-
-`number`
-
-Forwarded to `PowerCache`.
-
-#### Returns
-
-`PowerTimedCache`
-
-## Properties
-
-### cache
-
-> **cache**: [`PowerCache`](PowerCache.md)
-
-## Accessors
-
-### hitRate
-
-#### Get Signature
-
-> **get** **hitRate**(): `number`
-
-##### Returns
-
-`number`
-
-***
-
-### size
-
-#### Get Signature
-
-> **get** **size**(): `number`
-
-##### Returns
-
-`number`
-
-## Methods
-
-### clear()
-
-> **clear**(): `void`
-
-#### Returns
-
-`void`
-
-***
-
-### delete()
-
-> **delete**(`key`): `boolean`
-
-#### Parameters
-
-##### key
-
-`any`
-
-#### Returns
-
-`boolean`
-
-***
-
-### entries()
-
-> **entries**(`order`): `IterableIterator`\<\[`any`, `any`\], `any`, `any`\>
-
-#### Parameters
-
-##### order
-
-`any`
-
-#### Returns
-
-`IterableIterator`\<\[`any`, `any`\], `any`, `any`\>
-
-***
-
-### get()
-
-> **get**(`key`): `any`
-
-#### Parameters
-
-##### key
-
-`any`
-
-#### Returns
-
-`any`
-
-***
-
-### has()
-
-> **has**(`key`, `options`): `boolean`
-
-#### Parameters
-
-##### key
-
-`any`
-
-##### options
-
-`any`
-
-#### Returns
-
-`boolean`
-
-***
-
-### keys()
-
-> **keys**(`order`): `Generator`\<`any`, `void`, `unknown`\>
-
-#### Parameters
-
-##### order
-
-`any`
-
-#### Returns
-
-`Generator`\<`any`, `void`, `unknown`\>
-
-***
-
-### set()
-
-> **set**(`key`, `value`, `options`): `false` \| [`PowerCache`](PowerCache.md)
-
-#### Parameters
-
-##### key
-
-`any`
-
-##### value
-
-`any`
-
-##### options
-
-`any`
-
-#### Returns
-
-`false` \| [`PowerCache`](PowerCache.md)
-
-***
-
-### startCleanup()
-
-> **startCleanup**(`intervalOrOptions`): `void`
-
-#### Parameters
-
-##### intervalOrOptions
-
-`any`
-
-#### Returns
-
-`void`
-
-***
-
-### stats()
-
-> **stats**(): `object`
-
-#### Returns
-
-`object`
-
-##### evictions
-
-> **evictions**: `number`
-
-##### hits
-
-> **hits**: `number`
-
-##### misses
-
-> **misses**: `number`
-
-##### poolSize
-
-> **poolSize**: `number`
-
-##### rejected
-
-> **rejected**: `number`
-
-##### size
-
-> **size**: `number`
-
-##### weight
-
-> **weight**: `number`
-
-***
-
-### stopCleanup()
-
-> **stopCleanup**(): `void`
-
-#### Returns
-
-`void`
-
-***
-
-### values()
-
-> **values**(`order`): `Generator`\<`any`, `void`, `unknown`\>
-
-#### Parameters
-
-##### order
-
-`any`
-
-#### Returns
-
-`Generator`\<`any`, `void`, `unknown`\>

package/docs/helpers/powerCache/functions/simpleArgsKey.md

@@ -1,31 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerCache](../README.md) / simpleArgsKey
-
-# Function: simpleArgsKey()
-
-> **simpleArgsKey**(...`args`): `string`
-
-A small, fast key resolver for common cases where arguments are simple scalars.
-- Fast path for primitive scalar args (string, number, boolean, null, undefined).
-- Joins scalar args with `|` and prefixes type codes to avoid collisions.
-- Falls back to `JSON.stringify(args)` when any arg is a non-scalar (object, function, symbol).
-
-This is intended as a performant default for hot paths where most calls use
-simple identifiers (ids, numbers, short strings). It is deterministic but
-not suitable for canonicalizing complex objects — provide a custom
-`keyResolver` in that case.
-
-Example: `new PowerMemoizer(fn, { keyResolver: simpleArgsKey })`
-
-## Parameters
-
-### args
-
-...`any`[]
-
-## Returns
-
-`string`

package/docs/helpers/powerChunking/README.md

@@ -1,17 +0,0 @@
-[**performance-helpers**](../../README.md)
-
-***
-
-[performance-helpers](../../README.md) / helpers/powerChunking
-
-# helpers/powerChunking
-
-## Classes
-
-- [PowerChunker](classes/PowerChunker.md)
-
-## References
-
-### PowerChunkingOptions
-
-Re-exports [PowerChunkingOptions](../jsdoc-types/interfaces/PowerChunkingOptions.md)

package/docs/helpers/powerChunking/classes/PowerChunker.md

@@ -1,78 +0,0 @@
-[**performance-helpers**](../../../README.md)
-
-***
-
-[performance-helpers](../../../README.md) / [helpers/powerChunking](../README.md) / PowerChunker
-
-# Class: PowerChunker
-
-PowerChunking helper (class `PowerChunker`)
-
-Construct with `new PowerChunker(iterable, fn, options)` to create a
-helper that heuristically chunks an iterable and runs `fn` for every item
-inside lightweight inline worker-like instances managed by a `PowerPool`.
-The constructor returns the created `PowerPool` instance so callers can
-interact with it (listen `onmessage`, call `drain()`, `terminate()`, etc.).
-
-Usage:
-```js
-const pool = new PowerChunker(iterable, fn, options);
-pool.onmessage = (e) => { // handle per-chunk results };
-await pool.drain();
-```
-
-Notes:
-- This helper creates lightweight inline worker-like instances that execute
-  `fn(item, index, chunk)` on each chunk element asynchronously (via
-  setTimeout) so tests and environments without real Worker support still work.
-- For heavy CPU work prefer a real Worker source string and create your own
-  `PowerPool` instead; this helper focuses on convenience and correctness.
-
-## Param
-
-Input iterable of items to process.
-
-## Param
-
-Function to call for each item: `(item, index?, chunk?) => void`.
-
-## Param
-
-## Param
-
-Options forwarded to `PowerPool` constructor.
-
-## Param
-
-Options forwarded to `postMessageBatch`.
-
-## Param
-
-Explicit chunk size to use. When omitted a heuristic is used.
-
-## Param
-
-Hint about `fn` complexity to bias chunking.
- PowerChunker
-
-## Constructors
-
-### Constructor
-
-> **new PowerChunker**(`iterable`, `fn`, `options?`): `PowerChunker`
-
-#### Parameters
-
-##### iterable
-
-`any`
-
-##### fn
-
-`any`
-
-##### options?
-
-#### Returns
-
-`PowerChunker`

package/docs/helpers/powerCircuit/README.md

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