performance-helpers 1.0.0 → 1.0.1
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.
- package/README.md +12 -2
- package/package.json +146 -1
- package/src/index.js +1 -0
- package/.eslintrc.cjs +0 -22
- package/.nojekyll +0 -0
- package/.prettierrc +0 -6
- package/CONTRIBUTING.md +0 -178
- package/assets/1_Caching.md +0 -4
- package/assets/2_Parallelizing.md +0 -18
- package/assets/3_Logging.md +0 -3
- package/assets/404.md +0 -3
- package/assets/4_Utils.md +0 -10
- package/assets/logo.png +0 -0
- package/assets/navigation.md +0 -10
- package/bench/README.md +0 -97
- package/bench/results.json +0 -94
- package/bench/results.md +0 -233
- package/bench/run.js +0 -2639
- package/bench/worker.js +0 -43
- package/docs/README.md +0 -38
- package/docs/docs-typedoc.json +0 -38714
- package/docs/helpers/constants/README.md +0 -34
- package/docs/helpers/constants/variables/DEFAULT_AUTOSCALE_BACKOFF_MAX_MULTIPLIER.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_AUTOSCALE_COOLDOWN_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_AUTOSCALE_INTERVAL_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_AUTOSCALE_MIN_INTERVAL_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_BACKPRESSURE_QUEUE_CAPACITY.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_BACKPRESSURE_REFILL_INTERVAL_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_BATCH_MAX_SIZE.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_CACHE_DEFAULT_TTL_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_CACHE_MAX_POOL_SIZE.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_CACHE_MAX_WEIGHT_BYTES.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_HISTOGRAM_BUCKET_COUNT.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_HISTOGRAM_MAX_VALUE.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_MAX_CLEANUP_PER_TICK.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_QUEUE_CAPACITY.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_REAPER_MIN_INTERVAL_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_REFILL_INTERVAL_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_RETRY_BASE_DELAY_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_RETRY_MAX_DELAY_MS.md +0 -9
- package/docs/helpers/constants/variables/DEFAULT_TIMEOUT_MS.md +0 -9
- package/docs/helpers/constants/variables/ENCODE_CACHE_LARGE_KEY_LENGTH.md +0 -9
- package/docs/helpers/constants/variables/MAX_DEEP_EQUAL_DEPTH.md +0 -9
- package/docs/helpers/constants/variables/MS_PER_MIN.md +0 -9
- package/docs/helpers/constants/variables/MS_PER_SEC.md +0 -9
- package/docs/helpers/constants/variables/default.md +0 -103
- package/docs/helpers/jsdoc-types/README.md +0 -33
- package/docs/helpers/jsdoc-types/interfaces/BufferDecoder.md +0 -23
- package/docs/helpers/jsdoc-types/interfaces/BufferEncoder.md +0 -23
- package/docs/helpers/jsdoc-types/interfaces/CacheNode.md +0 -43
- package/docs/helpers/jsdoc-types/interfaces/CommonPoolOptions.md +0 -31
- package/docs/helpers/jsdoc-types/interfaces/PendingResponseEntry.md +0 -51
- package/docs/helpers/jsdoc-types/interfaces/PostMessageOptions.md +0 -39
- package/docs/helpers/jsdoc-types/interfaces/PowerBatchOptions.md +0 -13
- package/docs/helpers/jsdoc-types/interfaces/PowerCacheOptions.md +0 -115
- package/docs/helpers/jsdoc-types/interfaces/PowerChunkingOptions.md +0 -31
- package/docs/helpers/jsdoc-types/interfaces/PowerCircuitOptions.md +0 -45
- package/docs/helpers/jsdoc-types/interfaces/PowerDeadlineOptions.md +0 -101
- package/docs/helpers/jsdoc-types/interfaces/PowerDeferOptions.md +0 -13
- package/docs/helpers/jsdoc-types/interfaces/PowerEventBusOptions.md +0 -19
- package/docs/helpers/jsdoc-types/interfaces/PowerLatchOptions.md +0 -23
- package/docs/helpers/jsdoc-types/interfaces/PowerLoggerOptions.md +0 -51
- package/docs/helpers/jsdoc-types/interfaces/PowerObserverOptions.md +0 -25
- package/docs/helpers/jsdoc-types/interfaces/PowerPoolOptions.md +0 -85
- package/docs/helpers/jsdoc-types/interfaces/PowerQueueOptions.md +0 -13
- package/docs/helpers/jsdoc-types/interfaces/PowerRetryOptions.md +0 -83
- package/docs/helpers/jsdoc-types/interfaces/PowerSlidingWindowOptions.md +0 -19
- package/docs/helpers/jsdoc-types/interfaces/PowerTTLMapOptions.md +0 -27
- package/docs/helpers/jsdoc-types/interfaces/PowerThrottleOptions.md +0 -31
- package/docs/helpers/jsdoc-types/interfaces/WorkerObj.md +0 -55
- package/docs/helpers/powerBackpressure/README.md +0 -17
- package/docs/helpers/powerBackpressure/classes/PowerBackpressure.md +0 -368
- package/docs/helpers/powerBatch/README.md +0 -17
- package/docs/helpers/powerBatch/classes/PowerBatch.md +0 -139
- package/docs/helpers/powerBuffer/README.md +0 -26
- package/docs/helpers/powerBuffer/functions/b2o.md +0 -25
- package/docs/helpers/powerBuffer/functions/o2b.md +0 -23
- package/docs/helpers/powerBuffer/functions/o2u8.md +0 -33
- package/docs/helpers/powerBuffer/functions/u82o.md +0 -30
- package/docs/helpers/powerBulkhead/README.md +0 -17
- package/docs/helpers/powerBulkhead/classes/PowerBulkhead.md +0 -302
- package/docs/helpers/powerCache/README.md +0 -29
- package/docs/helpers/powerCache/classes/PowerCache.md +0 -933
- package/docs/helpers/powerCache/classes/PowerMemoizer.md +0 -244
- package/docs/helpers/powerCache/classes/PowerTimedCache.md +0 -302
- package/docs/helpers/powerCache/functions/simpleArgsKey.md +0 -31
- package/docs/helpers/powerChunking/README.md +0 -17
- package/docs/helpers/powerChunking/classes/PowerChunker.md +0 -78
- package/docs/helpers/powerCircuit/README.md +0 -23
- package/docs/helpers/powerCircuit/classes/PowerCircuit.md +0 -167
- package/docs/helpers/powerDeadline/README.md +0 -23
- package/docs/helpers/powerDeadline/classes/PowerDeadline.md +0 -88
- package/docs/helpers/powerDefer/README.md +0 -17
- package/docs/helpers/powerDefer/classes/PowerDefer.md +0 -134
- package/docs/helpers/powerEventBus/README.md +0 -23
- package/docs/helpers/powerEventBus/classes/PowerEventBus.md +0 -330
- package/docs/helpers/powerHistogram/README.md +0 -17
- package/docs/helpers/powerHistogram/classes/PowerHistogram.md +0 -285
- package/docs/helpers/powerLatch/README.md +0 -17
- package/docs/helpers/powerLatch/classes/PowerLatch.md +0 -264
- package/docs/helpers/powerLogger/README.md +0 -17
- package/docs/helpers/powerLogger/classes/PowerLogger.md +0 -290
- package/docs/helpers/powerObserver/README.md +0 -23
- package/docs/helpers/powerObserver/classes/PowerObserver.md +0 -213
- package/docs/helpers/powerPermitGate/README.md +0 -11
- package/docs/helpers/powerPermitGate/classes/PowerPermitGate.md +0 -248
- package/docs/helpers/powerPool/README.md +0 -36
- package/docs/helpers/powerPool/classes/PowerPool.md +0 -973
- package/docs/helpers/powerPool/classes/PowerPoolShutdownError.md +0 -67
- package/docs/helpers/powerQueue/README.md +0 -11
- package/docs/helpers/powerQueue/classes/PowerQueue.md +0 -302
- package/docs/helpers/powerRateLimit/README.md +0 -17
- package/docs/helpers/powerRateLimit/classes/PowerRateLimit.md +0 -187
- package/docs/helpers/powerRetry/README.md +0 -23
- package/docs/helpers/powerRetry/classes/PowerRetry.md +0 -106
- package/docs/helpers/powerScheduler/README.md +0 -11
- package/docs/helpers/powerScheduler/classes/PowerScheduler.md +0 -135
- package/docs/helpers/powerSemaphore/README.md +0 -17
- package/docs/helpers/powerSemaphore/classes/PowerSemaphore.md +0 -173
- package/docs/helpers/powerSlidingWindow/README.md +0 -11
- package/docs/helpers/powerSlidingWindow/classes/PowerSlidingWindow.md +0 -83
- package/docs/helpers/powerSubscriberSet/README.md +0 -15
- package/docs/helpers/powerSubscriberSet/classes/PowerSubscriberSet.md +0 -251
- package/docs/helpers/powerSubscriberSet/functions/cleanupWeakRefs.md +0 -21
- package/docs/helpers/powerTTLMap/README.md +0 -17
- package/docs/helpers/powerTTLMap/classes/PowerTTLMap.md +0 -326
- package/docs/helpers/powerThrottle/README.md +0 -17
- package/docs/helpers/powerThrottle/classes/PowerThrottle.md +0 -216
- package/docs/index/README.md +0 -205
- package/docs/utils/errors/README.md +0 -12
- package/docs/utils/errors/functions/formatErrorObj.md +0 -30
- package/docs/utils/errors/functions/normalizeError.md +0 -50
- package/docs/utils/now/README.md +0 -19
- package/docs/utils/now/functions/measureAsync.md +0 -37
- package/docs/utils/now/functions/measureSync.md +0 -54
- package/docs/utils/now/functions/nowMs.md +0 -24
- package/guides/autoscale.md +0 -80
- package/guides/errors.md +0 -41
- package/guides/metaGuide.md +0 -440
- package/guides/now.md +0 -56
- package/guides/powerBackpressure.md +0 -110
- package/guides/powerBatch.md +0 -82
- package/guides/powerBuffer.md +0 -86
- package/guides/powerBulkhead.md +0 -61
- package/guides/powerCache.md +0 -269
- package/guides/powerChunking.md +0 -130
- package/guides/powerCircuit.md +0 -84
- package/guides/powerDeadline.md +0 -99
- package/guides/powerDefer.md +0 -56
- package/guides/powerEventBus.md +0 -89
- package/guides/powerHistogram.md +0 -71
- package/guides/powerLatch.md +0 -94
- package/guides/powerLogger.md +0 -129
- package/guides/powerObserver.md +0 -65
- package/guides/powerPermitGate.md +0 -52
- package/guides/powerPool.md +0 -321
- package/guides/powerQueue.md +0 -112
- package/guides/powerRateLimit.md +0 -37
- package/guides/powerRetry.md +0 -54
- package/guides/powerScheduler.md +0 -41
- package/guides/powerSemaphore.md +0 -65
- package/guides/powerSlidingWindow.md +0 -63
- package/guides/powerSubscriberSet.md +0 -48
- package/guides/powerTTLMap.md +0 -58
- package/guides/powerThrottle.md +0 -152
- package/index.html +0 -57
- package/results.json +0 -6692
- package/scripts/find-missing-jsdoc.js +0 -62
- package/scripts/modernize-optional-chaining.cjs +0 -36
- package/scripts/pool-debug.mjs +0 -29
- package/scripts/repro_powercache.js +0 -14
- package/scripts/static-audit-exports.cjs +0 -93
- package/scripts/static-audit-exports.json +0 -518
- package/test/powerBackpressure.test.js +0 -114
- package/test/powerBatch.branches.extra.test.js +0 -122
- package/test/powerBatch.test.js +0 -79
- package/test/powerBuffer.test.js +0 -125
- package/test/powerBulkhead.test.js +0 -210
- package/test/powerCache.branches.test.js +0 -233
- package/test/powerCache.bulk.test.js +0 -31
- package/test/powerCache.getorset.test.js +0 -110
- package/test/powerCache.hitRate.test.js +0 -35
- package/test/powerCache.inflight.test.js +0 -24
- package/test/powerCache.iterator.test.js +0 -18
- package/test/powerCache.misses.test.js +0 -52
- package/test/powerCache.more.test.js +0 -118
- package/test/powerCache.test.js +0 -37
- package/test/powerCache.timeout.test.js +0 -25
- package/test/powerCache.touch.test.js +0 -46
- package/test/powerChunking.branches.extra.test.js +0 -155
- package/test/powerChunking.errors.test.js +0 -177
- package/test/powerChunking.test.js +0 -39
- package/test/powerCircuit.observability.test.js +0 -71
- package/test/powerCircuit.test.js +0 -74
- package/test/powerDeadline.test.js +0 -140
- package/test/powerDefer.test.js +0 -55
- package/test/powerErrors.test.js +0 -32
- package/test/powerEventBus.branches.extra.test.js +0 -70
- package/test/powerEventBus.extra.test.js +0 -72
- package/test/powerEventBus.max.test.js +0 -43
- package/test/powerEventBus.more.test.js +0 -121
- package/test/powerEventBus.once_off.test.js +0 -17
- package/test/powerEventBus.test.js +0 -74
- package/test/powerEventBus.uncovered.test.js +0 -57
- package/test/powerEventBus.weak.test.js +0 -18
- package/test/powerHistogram.test.js +0 -73
- package/test/powerLatch.branches.extra.test.js +0 -115
- package/test/powerLatch.test.js +0 -57
- package/test/powerLogger.branches.test.js +0 -98
- package/test/powerLogger.formatter.name.test.js +0 -58
- package/test/powerLogger.json.test.js +0 -88
- package/test/powerLogger.output.test.js +0 -81
- package/test/powerLogger.table.debug.test.js +0 -77
- package/test/powerLogger.test.js +0 -59
- package/test/powerMemoizer.memoize.test.js +0 -100
- package/test/powerMemoizer.test.js +0 -85
- package/test/powerObserver.test.js +0 -129
- package/test/powerPermitGate.test.js +0 -66
- package/test/powerPool.autoTransfer.test.js +0 -100
- package/test/powerPool.autoscale.extra.test.js +0 -88
- package/test/powerPool.autoscale.test.js +0 -136
- package/test/powerPool.awaitDefaultTimeout.test.js +0 -52
- package/test/powerPool.awaitTimeout.test.js +0 -22
- package/test/powerPool.batch.test.js +0 -170
- package/test/powerPool.branches.extra2.test.js +0 -42
- package/test/powerPool.branches.test.js +0 -102
- package/test/powerPool.browser.messageerror.test.js +0 -45
- package/test/powerPool.correlation.test.js +0 -26
- package/test/powerPool.correlationId.test.js +0 -63
- package/test/powerPool.dispose.test.js +0 -49
- package/test/powerPool.drain.test.js +0 -57
- package/test/powerPool.events.test.js +0 -131
- package/test/powerPool.more.extra.test.js +0 -99
- package/test/powerPool.more.test.js +0 -283
- package/test/powerPool.node.messageerror.test.js +0 -46
- package/test/powerPool.postMessage.promise.test.js +0 -83
- package/test/powerPool.queueHigh.test.js +0 -55
- package/test/powerPool.queueSaturation.test.js +0 -51
- package/test/powerPool.rapidResize.test.js +0 -55
- package/test/powerPool.resize.overload.test.js +0 -65
- package/test/powerPool.resize.test.js +0 -70
- package/test/powerPool.shutdown.test.js +0 -38
- package/test/powerPool.stats.test.js +0 -40
- package/test/powerPool.stopThePress.test.js +0 -94
- package/test/powerPool.terminateShutdown.test.js +0 -22
- package/test/powerPool.test.js +0 -525
- package/test/powerPool.timers.test.js +0 -55
- package/test/powerPool.uncovered.test.js +0 -407
- package/test/powerPool.workerId.test.js +0 -47
- package/test/powerQueue.iterators.test.js +0 -67
- package/test/powerQueue.saturation.test.js +0 -18
- package/test/powerQueue.test.js +0 -48
- package/test/powerQueue.unshiftMany.test.js +0 -49
- package/test/powerRateLimit.atomic.test.js +0 -80
- package/test/powerRateLimit.extra.test.js +0 -145
- package/test/powerRateLimit.functions.test.js +0 -106
- package/test/powerRateLimit.test.js +0 -38
- package/test/powerRetry.attemptTimeout.test.js +0 -51
- package/test/powerRetry.test.js +0 -121
- package/test/powerScheduler.test.js +0 -126
- package/test/powerSemaphore.test.js +0 -108
- package/test/powerSlidingWindow.pool.test.js +0 -55
- package/test/powerSlidingWindow.test.js +0 -25
- package/test/powerSubscriberSet.test.js +0 -125
- package/test/powerTTLMap.test.js +0 -125
- package/test/powerThrottle.pool.test.js +0 -54
- package/test/powerThrottle.refill.test.js +0 -22
- package/test/powerThrottle.reserve.test.js +0 -46
- package/test/powerThrottle.test.js +0 -45
- package/test/powerTimedCache.test.js +0 -73
- package/test/umd.bundle.branches.test.js +0 -100
- package/test/umd.bundle.cache-timers.test.js +0 -48
- package/test/umd.bundle.exhaustive.test.js +0 -158
- package/test/umd.bundle.fuzz.test.js +0 -86
- package/test/umd.bundle.hasEqual.more.test.js +0 -68
- package/test/umd.bundle.hasEqual.test.js +0 -104
- package/test/umd.bundle.logger-extra.test.js +0 -48
- package/test/umd.bundle.more-coverage-2.test.js +0 -67
- package/test/umd.bundle.pool.test.js +0 -134
- package/test/umd.bundle.test.js +0 -265
- package/test/utils.measure.test.js +0 -49
- package/test/utils.now.extra.test.js +0 -30
- package/test/utils.now.more.test.js +0 -57
- package/tsconfig.json +0 -16
- package/typedoc.json +0 -25
- package/vite.config.js +0 -31
- package/vitest.config.js +0 -17
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
[**performance-helpers**](../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[performance-helpers](../../../README.md) / [helpers/powerBuffer](../README.md) / u82o
|
|
6
|
-
|
|
7
|
-
# Function: u82o()
|
|
8
|
-
|
|
9
|
-
> **u82o**(`buf`): `any`
|
|
10
|
-
|
|
11
|
-
Decode a UTF-8 encoded binary (ArrayBuffer/TypedArray/Buffer/Uint8Array)
|
|
12
|
-
into a JavaScript value by parsing JSON.
|
|
13
|
-
|
|
14
|
-
## Parameters
|
|
15
|
-
|
|
16
|
-
### buf
|
|
17
|
-
|
|
18
|
-
`any`
|
|
19
|
-
|
|
20
|
-
Binary input.
|
|
21
|
-
|
|
22
|
-
## Returns
|
|
23
|
-
|
|
24
|
-
`any`
|
|
25
|
-
|
|
26
|
-
Parsed value.
|
|
27
|
-
|
|
28
|
-
## Throws
|
|
29
|
-
|
|
30
|
-
If the input type is unsupported.
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
[**performance-helpers**](../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[performance-helpers](../../README.md) / helpers/powerBulkhead
|
|
6
|
-
|
|
7
|
-
# helpers/powerBulkhead
|
|
8
|
-
|
|
9
|
-
## Classes
|
|
10
|
-
|
|
11
|
-
- [PowerBulkhead](classes/PowerBulkhead.md)
|
|
12
|
-
|
|
13
|
-
## References
|
|
14
|
-
|
|
15
|
-
### default
|
|
16
|
-
|
|
17
|
-
Renames and re-exports [PowerBulkhead](classes/PowerBulkhead.md)
|
|
@@ -1,302 +0,0 @@
|
|
|
1
|
-
[**performance-helpers**](../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[performance-helpers](../../../README.md) / [helpers/powerBulkhead](../README.md) / PowerBulkhead
|
|
6
|
-
|
|
7
|
-
# Class: PowerBulkhead
|
|
8
|
-
|
|
9
|
-
PowerBulkhead
|
|
10
|
-
|
|
11
|
-
Partitioned executor that isolates noisy workloads into separate
|
|
12
|
-
concurrency partitions to avoid starving critical paths.
|
|
13
|
-
|
|
14
|
-
PowerBulkhead
|
|
15
|
-
|
|
16
|
-
## Constructors
|
|
17
|
-
|
|
18
|
-
### Constructor
|
|
19
|
-
|
|
20
|
-
> **new PowerBulkhead**(`options?`): `PowerBulkhead`
|
|
21
|
-
|
|
22
|
-
#### Parameters
|
|
23
|
-
|
|
24
|
-
##### options?
|
|
25
|
-
|
|
26
|
-
###### maxConcurrency?
|
|
27
|
-
|
|
28
|
-
`number`
|
|
29
|
-
|
|
30
|
-
Maximum concurrent tasks per partition.
|
|
31
|
-
|
|
32
|
-
###### partitioner?
|
|
33
|
-
|
|
34
|
-
`Function`
|
|
35
|
-
|
|
36
|
-
Function `(key)=>partitionIndex`.
|
|
37
|
-
|
|
38
|
-
###### partitions?
|
|
39
|
-
|
|
40
|
-
`number`
|
|
41
|
-
|
|
42
|
-
Number of isolated execution partitions.
|
|
43
|
-
|
|
44
|
-
###### queueCapacity?
|
|
45
|
-
|
|
46
|
-
`number`
|
|
47
|
-
|
|
48
|
-
Maximum queued tasks across all partitions.
|
|
49
|
-
|
|
50
|
-
#### Returns
|
|
51
|
-
|
|
52
|
-
`PowerBulkhead`
|
|
53
|
-
|
|
54
|
-
## Properties
|
|
55
|
-
|
|
56
|
-
### \_activeCount
|
|
57
|
-
|
|
58
|
-
> **\_activeCount**: `number`
|
|
59
|
-
|
|
60
|
-
***
|
|
61
|
-
|
|
62
|
-
### \_buckets
|
|
63
|
-
|
|
64
|
-
> **\_buckets**: `object`[]
|
|
65
|
-
|
|
66
|
-
#### gate
|
|
67
|
-
|
|
68
|
-
> **gate**: [`PowerPermitGate`](../../powerPermitGate/classes/PowerPermitGate.md)
|
|
69
|
-
|
|
70
|
-
***
|
|
71
|
-
|
|
72
|
-
### \_drainWaiters
|
|
73
|
-
|
|
74
|
-
> **\_drainWaiters**: [`PowerQueue`](../../powerQueue/classes/PowerQueue.md)
|
|
75
|
-
|
|
76
|
-
***
|
|
77
|
-
|
|
78
|
-
### \_maxConcurrency
|
|
79
|
-
|
|
80
|
-
> **\_maxConcurrency**: `number`
|
|
81
|
-
|
|
82
|
-
***
|
|
83
|
-
|
|
84
|
-
### \_nextPartition
|
|
85
|
-
|
|
86
|
-
> **\_nextPartition**: `number`
|
|
87
|
-
|
|
88
|
-
***
|
|
89
|
-
|
|
90
|
-
### \_partitioner
|
|
91
|
-
|
|
92
|
-
> **\_partitioner**: `Function` \| `null`
|
|
93
|
-
|
|
94
|
-
***
|
|
95
|
-
|
|
96
|
-
### \_partitions
|
|
97
|
-
|
|
98
|
-
> **\_partitions**: `number`
|
|
99
|
-
|
|
100
|
-
***
|
|
101
|
-
|
|
102
|
-
### \_pendingCount
|
|
103
|
-
|
|
104
|
-
> **\_pendingCount**: `number`
|
|
105
|
-
|
|
106
|
-
***
|
|
107
|
-
|
|
108
|
-
### \_queueCapacity
|
|
109
|
-
|
|
110
|
-
> **\_queueCapacity**: `number`
|
|
111
|
-
|
|
112
|
-
## Accessors
|
|
113
|
-
|
|
114
|
-
### active
|
|
115
|
-
|
|
116
|
-
#### Get Signature
|
|
117
|
-
|
|
118
|
-
> **get** **active**(): `number`
|
|
119
|
-
|
|
120
|
-
Total number of running tasks across all partitions.
|
|
121
|
-
|
|
122
|
-
##### Returns
|
|
123
|
-
|
|
124
|
-
`number`
|
|
125
|
-
|
|
126
|
-
***
|
|
127
|
-
|
|
128
|
-
### isFull
|
|
129
|
-
|
|
130
|
-
#### Get Signature
|
|
131
|
-
|
|
132
|
-
> **get** **isFull**(): `boolean`
|
|
133
|
-
|
|
134
|
-
True when the bulkhead queue is saturated.
|
|
135
|
-
|
|
136
|
-
##### Returns
|
|
137
|
-
|
|
138
|
-
`boolean`
|
|
139
|
-
|
|
140
|
-
***
|
|
141
|
-
|
|
142
|
-
### maxConcurrency
|
|
143
|
-
|
|
144
|
-
#### Get Signature
|
|
145
|
-
|
|
146
|
-
> **get** **maxConcurrency**(): `number`
|
|
147
|
-
|
|
148
|
-
Maximum concurrent tasks allowed per partition.
|
|
149
|
-
|
|
150
|
-
##### Returns
|
|
151
|
-
|
|
152
|
-
`number`
|
|
153
|
-
|
|
154
|
-
***
|
|
155
|
-
|
|
156
|
-
### partitions
|
|
157
|
-
|
|
158
|
-
#### Get Signature
|
|
159
|
-
|
|
160
|
-
> **get** **partitions**(): `number`
|
|
161
|
-
|
|
162
|
-
Number of partitions used for workload isolation.
|
|
163
|
-
|
|
164
|
-
##### Returns
|
|
165
|
-
|
|
166
|
-
`number`
|
|
167
|
-
|
|
168
|
-
***
|
|
169
|
-
|
|
170
|
-
### pending
|
|
171
|
-
|
|
172
|
-
#### Get Signature
|
|
173
|
-
|
|
174
|
-
> **get** **pending**(): `number`
|
|
175
|
-
|
|
176
|
-
Total number of currently queued tasks.
|
|
177
|
-
|
|
178
|
-
##### Returns
|
|
179
|
-
|
|
180
|
-
`number`
|
|
181
|
-
|
|
182
|
-
***
|
|
183
|
-
|
|
184
|
-
### queueCapacity
|
|
185
|
-
|
|
186
|
-
#### Get Signature
|
|
187
|
-
|
|
188
|
-
> **get** **queueCapacity**(): `number`
|
|
189
|
-
|
|
190
|
-
Maximum number of tasks that may wait in the queue.
|
|
191
|
-
|
|
192
|
-
##### Returns
|
|
193
|
-
|
|
194
|
-
`number`
|
|
195
|
-
|
|
196
|
-
## Methods
|
|
197
|
-
|
|
198
|
-
### \_choosePartition()
|
|
199
|
-
|
|
200
|
-
> **\_choosePartition**(`key`): `number`
|
|
201
|
-
|
|
202
|
-
#### Parameters
|
|
203
|
-
|
|
204
|
-
##### key
|
|
205
|
-
|
|
206
|
-
`any`
|
|
207
|
-
|
|
208
|
-
#### Returns
|
|
209
|
-
|
|
210
|
-
`number`
|
|
211
|
-
|
|
212
|
-
***
|
|
213
|
-
|
|
214
|
-
### \_hashKey()
|
|
215
|
-
|
|
216
|
-
> **\_hashKey**(`value`): `number`
|
|
217
|
-
|
|
218
|
-
#### Parameters
|
|
219
|
-
|
|
220
|
-
##### value
|
|
221
|
-
|
|
222
|
-
`any`
|
|
223
|
-
|
|
224
|
-
#### Returns
|
|
225
|
-
|
|
226
|
-
`number`
|
|
227
|
-
|
|
228
|
-
***
|
|
229
|
-
|
|
230
|
-
### \_resolveDrainWaitersIfIdle()
|
|
231
|
-
|
|
232
|
-
> **\_resolveDrainWaitersIfIdle**(): `void`
|
|
233
|
-
|
|
234
|
-
#### Returns
|
|
235
|
-
|
|
236
|
-
`void`
|
|
237
|
-
|
|
238
|
-
***
|
|
239
|
-
|
|
240
|
-
### drain()
|
|
241
|
-
|
|
242
|
-
> **drain**(): `Promise`\<`void`\>
|
|
243
|
-
|
|
244
|
-
Wait for all active and queued tasks to complete.
|
|
245
|
-
|
|
246
|
-
#### Returns
|
|
247
|
-
|
|
248
|
-
`Promise`\<`void`\>
|
|
249
|
-
|
|
250
|
-
***
|
|
251
|
-
|
|
252
|
-
### run()
|
|
253
|
-
|
|
254
|
-
> **run**(`task`, `options?`): `Promise`\<`any`\>
|
|
255
|
-
|
|
256
|
-
Enqueue a task for execution under partition isolation.
|
|
257
|
-
|
|
258
|
-
#### Parameters
|
|
259
|
-
|
|
260
|
-
##### task
|
|
261
|
-
|
|
262
|
-
`Function`
|
|
263
|
-
|
|
264
|
-
Async callback to execute.
|
|
265
|
-
|
|
266
|
-
##### options?
|
|
267
|
-
|
|
268
|
-
###### partitionKey?
|
|
269
|
-
|
|
270
|
-
`any`
|
|
271
|
-
|
|
272
|
-
Optional key used to route the task to a partition.
|
|
273
|
-
|
|
274
|
-
#### Returns
|
|
275
|
-
|
|
276
|
-
`Promise`\<`any`\>
|
|
277
|
-
|
|
278
|
-
Promise resolving or rejecting with task result.
|
|
279
|
-
|
|
280
|
-
***
|
|
281
|
-
|
|
282
|
-
### tryRun()
|
|
283
|
-
|
|
284
|
-
> **tryRun**(`task`, `options?`): `Promise`\<`any`\> \| `null`
|
|
285
|
-
|
|
286
|
-
Try to execute immediately without queuing.
|
|
287
|
-
|
|
288
|
-
#### Parameters
|
|
289
|
-
|
|
290
|
-
##### task
|
|
291
|
-
|
|
292
|
-
`Function`
|
|
293
|
-
|
|
294
|
-
##### options?
|
|
295
|
-
|
|
296
|
-
###### partitionKey?
|
|
297
|
-
|
|
298
|
-
`any`
|
|
299
|
-
|
|
300
|
-
#### Returns
|
|
301
|
-
|
|
302
|
-
`Promise`\<`any`\> \| `null`
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[**performance-helpers**](../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[performance-helpers](../../README.md) / helpers/powerCache
|
|
6
|
-
|
|
7
|
-
# helpers/powerCache
|
|
8
|
-
|
|
9
|
-
## Classes
|
|
10
|
-
|
|
11
|
-
- [PowerCache](classes/PowerCache.md)
|
|
12
|
-
- [PowerMemoizer](classes/PowerMemoizer.md)
|
|
13
|
-
- [PowerTimedCache](classes/PowerTimedCache.md)
|
|
14
|
-
|
|
15
|
-
## Functions
|
|
16
|
-
|
|
17
|
-
- [simpleArgsKey](functions/simpleArgsKey.md)
|
|
18
|
-
|
|
19
|
-
## References
|
|
20
|
-
|
|
21
|
-
### CacheNode
|
|
22
|
-
|
|
23
|
-
Re-exports [CacheNode](../jsdoc-types/interfaces/CacheNode.md)
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### PowerCacheOptions
|
|
28
|
-
|
|
29
|
-
Re-exports [PowerCacheOptions](../jsdoc-types/interfaces/PowerCacheOptions.md)
|