From b4d61a7596f314145be453ddbcaa9b0dade39bfb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 4 Apr 2023 08:09:03 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/ClusterWorker.html | 26 ++++---- docs/classes/DynamicClusterPool.html | 66 +++++++++---------- docs/classes/DynamicThreadPool.html | 66 +++++++++---------- docs/classes/FixedClusterPool.html | 64 +++++++++--------- docs/classes/FixedThreadPool.html | 64 +++++++++--------- docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 26 ++++---- docs/interfaces/ClusterPoolOptions.html | 18 ++--- docs/interfaces/IPool.html | 10 +-- docs/interfaces/PoolOptions.html | 14 ++-- docs/interfaces/WorkerOptions.html | 8 +-- docs/types/ErrorHandler.html | 2 +- docs/types/ExitHandler.html | 2 +- docs/types/KillBehavior.html | 2 +- docs/types/MessageHandler.html | 2 +- docs/types/OnlineHandler.html | 2 +- .../types/ThreadWorkerWithMessageChannel.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- 20 files changed, 191 insertions(+), 191 deletions(-) diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 1b75d5b9..cd69cbcd 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.
Protected
lastProtected
mainReadonly
optsAsyncResource
to which the function is bound.
Protected
handleProtected
messageProtected
runProtected
runReadonly
fileProtected
Readonly
maxReadonly
numberReadonly
optsProtected
promiseProtected
workerReadonly
workersProtected
afterProtected
beforeProtected
chooseProtected
createProtected
createProtected
internalInherited from FixedClusterPool.internalGetBusyStatus
Protected
isInherited from FixedClusterPool.isMain
Inherited from FixedClusterPool.registerWorkerMessageListener
Protected
removeInherited from FixedClusterPool.removeWorker
Protected
sendInherited from FixedClusterPool.sendToWorker
Inherited from FixedClusterPool.setWorkerChoiceStrategy
Protected
setupInherited from FixedClusterPool.setupHook
Protected
workerInherited from FixedClusterPool.workerListener
Inherited from FixedThreadPool.filePath
Protected
Readonly
maxMaximum number of threads that can be created by this pool.
Readonly
numberInherited from FixedThreadPool.numberOfWorkers
Readonly
optsInherited from FixedThreadPool.opts
Protected
promiseInherited from FixedThreadPool.promiseResponseMap
Protected
workerInherited from FixedThreadPool.workerChoiceStrategyContext
Readonly
workersInherited from FixedThreadPool.workers
Overrides FixedThreadPool.busy
Inherited from FixedThreadPool.numberOfRunningTasks
Overrides FixedThreadPool.type
Inherited from FixedThreadPool.afterPromiseResponseHook
Protected
afterInherited from FixedThreadPool.afterWorkerSetup
Protected
beforeInherited from FixedThreadPool.beforePromiseResponseHook
Protected
chooseInherited from FixedThreadPool.chooseWorker
Protected
createInherited from FixedThreadPool.createAndSetupWorker
Protected
createInherited from FixedThreadPool.createWorker
Inherited from FixedThreadPool.destroy
Inherited from FixedThreadPool.destroyWorker
Inherited from FixedThreadPool.execute
{@inheritDoc}
Inherited from FixedThreadPool.findFreeWorkerKey
Protected
internalInherited from FixedThreadPool.internalGetBusyStatus
Protected
isInherited from FixedThreadPool.isMain
Inherited from FixedThreadPool.registerWorkerMessageListener
Protected
removeInherited from FixedThreadPool.removeWorker
Protected
sendInherited from FixedThreadPool.sendToWorker
Inherited from FixedThreadPool.setWorkerChoiceStrategy
Protected
setupInherited from FixedThreadPool.setupHook
Protected
workerInherited from FixedThreadPool.workerListener
Inherited from AbstractPool.filePath
Readonly
numberInherited from AbstractPool.numberOfWorkers
Readonly
optsInherited from AbstractPool.opts
Protected
promiseInherited from AbstractPool.promiseResponseMap
Protected
workerInherited from AbstractPool.workerChoiceStrategyContext
Readonly
workersInherited from AbstractPool.workers
Overrides AbstractPool.busy
Inherited from AbstractPool.numberOfRunningTasks
Overrides AbstractPool.type
Inherited from AbstractPool.afterPromiseResponseHook
Protected
afterOverrides AbstractPool.afterWorkerSetup
Protected
beforeInherited from AbstractPool.beforePromiseResponseHook
Protected
chooseInherited from AbstractPool.chooseWorker
Protected
createInherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Overrides AbstractPool.destroyWorker
Inherited from AbstractPool.execute
{@inheritDoc}
Inherited from AbstractPool.findFreeWorkerKey
Protected
internalInherited from AbstractPool.internalGetBusyStatus
Protected
isOverrides AbstractPool.isMain
Overrides AbstractPool.registerWorkerMessageListener
Protected
removeInherited from AbstractPool.removeWorker
Protected
sendOverrides AbstractPool.sendToWorker
Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupOverrides AbstractPool.setupHook
Protected
workerInherited from AbstractPool.workerListener
Inherited from AbstractPool.filePath
Readonly
numberInherited from AbstractPool.numberOfWorkers
Readonly
optsInherited from AbstractPool.opts
Protected
promiseInherited from AbstractPool.promiseResponseMap
Protected
workerInherited from AbstractPool.workerChoiceStrategyContext
Readonly
workersInherited from AbstractPool.workers
Overrides AbstractPool.busy
Inherited from AbstractPool.numberOfRunningTasks
Overrides AbstractPool.type
Inherited from AbstractPool.afterPromiseResponseHook
Protected
afterOverrides AbstractPool.afterWorkerSetup
Protected
beforeInherited from AbstractPool.beforePromiseResponseHook
Protected
chooseInherited from AbstractPool.chooseWorker
Protected
createInherited from AbstractPool.createAndSetupWorker
Protected
createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Overrides AbstractPool.destroyWorker
Inherited from AbstractPool.execute
{@inheritDoc}
Inherited from AbstractPool.findFreeWorkerKey
Protected
internalInherited from AbstractPool.internalGetBusyStatus
Protected
isOverrides AbstractPool.isMain
Overrides AbstractPool.registerWorkerMessageListener
Protected
removeInherited from AbstractPool.removeWorker
Protected
sendOverrides AbstractPool.sendToWorker
Inherited from AbstractPool.setWorkerChoiceStrategy
Protected
setupInherited from AbstractPool.setupHook
Protected
workerInherited from AbstractPool.workerListener
Inherited from AbstractWorker.lastTaskTimestamp
Protected
mainInherited from AbstractWorker.mainWorker
Readonly
optsInherited from AbstractWorker.opts
AsyncResource
to which the function is bound.
Inherited from AbstractWorker.checkAlive
Inherited from AbstractWorker.getMainWorker
Protected
handleInherited from AbstractWorker.handleError
Protected
messageInherited from AbstractWorker.messageListener
Protected
runInherited from AbstractWorker.run
Protected
runInherited from AbstractWorker.runAsync
Overrides AbstractWorker.sendToMainWorker
Inherited from PoolOptions.enableEvents
Optional
envhttps://nodejs.org/api/cluster.html#cluster_cluster_fork_env
Optional
errorInherited from PoolOptions.errorHandler
Optional
exitInherited from PoolOptions.exitHandler
Optional
messageInherited from PoolOptions.messageHandler
Optional
onlineInherited from PoolOptions.onlineHandler
Optional
settingshttps://nodejs.org/api/cluster.html#cluster_cluster_settings
Optional
workerInherited from PoolOptions.workerChoiceStrategy
Optional
Readonly
emitterOptional
max60000 ms
Maximum number of workers that can be created by this pool.