docs: generate typedoc documentation
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Fri, 15 Nov 2024 14:29:14 +0000 (15:29 +0100)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Fri, 15 Nov 2024 14:29:14 +0000 (15:29 +0100)
commit92daba400a9710d9a51af1c226f186e6fd2f8472
treec5c830de1b4c5aca85b9e4fec1037abb56292ebc
parent5a079a9ce7ed6aab00e20bcc78273bceca396d67
docs: generate typedoc documentation

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
145 files changed:
.lintstagedrc.js
docs/api.md
docs/assets/navigation.js
docs/assets/search.js
docs/classes/AbstractPool.html [deleted file]
docs/classes/AbstractWorker.html [deleted file]
docs/classes/CircularBuffer.html [deleted file]
docs/classes/ClusterWorker.html [deleted file]
docs/classes/DynamicClusterPool.html [deleted file]
docs/classes/DynamicThreadPool.html [deleted file]
docs/classes/FixedClusterPool.html [deleted file]
docs/classes/FixedThreadPool.html [deleted file]
docs/classes/PriorityQueue.html [deleted file]
docs/classes/ThreadWorker.html [deleted file]
docs/classes/WorkerChoiceStrategiesContext.html [deleted file]
docs/classes/src.AbstractPool.html [new file with mode: 0644]
docs/classes/src.AbstractWorker.html [new file with mode: 0644]
docs/classes/src.CircularBuffer.html [new file with mode: 0644]
docs/classes/src.ClusterWorker.html [new file with mode: 0644]
docs/classes/src.DynamicClusterPool.html [new file with mode: 0644]
docs/classes/src.DynamicThreadPool.html [new file with mode: 0644]
docs/classes/src.FixedClusterPool.html [new file with mode: 0644]
docs/classes/src.FixedThreadPool.html [new file with mode: 0644]
docs/classes/src.PriorityQueue.html [new file with mode: 0644]
docs/classes/src.ThreadWorker.html [new file with mode: 0644]
docs/classes/src.WorkerChoiceStrategiesContext.html [new file with mode: 0644]
docs/documents/api.html [new file with mode: 0644]
docs/documents/general_guidelines.html [new file with mode: 0644]
docs/documents/worker_choice_strategies.html [new file with mode: 0644]
docs/functions/availableParallelism.html [deleted file]
docs/functions/src.availableParallelism.html [new file with mode: 0644]
docs/hierarchy.html
docs/index.html
docs/interfaces/EventLoopUtilizationMeasurementStatistics.html [deleted file]
docs/interfaces/FixedQueueNode.html [deleted file]
docs/interfaces/IFixedQueue.html [deleted file]
docs/interfaces/IPool.html [deleted file]
docs/interfaces/IWorkerChoiceStrategy.html [deleted file]
docs/interfaces/MeasurementOptions.html [deleted file]
docs/interfaces/MeasurementStatistics.html [deleted file]
docs/interfaces/MeasurementStatisticsRequirements.html [deleted file]
docs/interfaces/MessageValue.html [deleted file]
docs/interfaces/PoolInfo.html [deleted file]
docs/interfaces/PoolOptions.html [deleted file]
docs/interfaces/PromiseResponseWrapper.html [deleted file]
docs/interfaces/StrategyData.html [deleted file]
docs/interfaces/StrategyPolicy.html [deleted file]
docs/interfaces/Task.html [deleted file]
docs/interfaces/TaskFunctionObject.html [deleted file]
docs/interfaces/TaskFunctionOperationResult.html [deleted file]
docs/interfaces/TaskFunctionProperties.html [deleted file]
docs/interfaces/TaskPerformance.html [deleted file]
docs/interfaces/TaskStatistics.html [deleted file]
docs/interfaces/TaskStatisticsRequirements.html [deleted file]
docs/interfaces/TasksQueueOptions.html [deleted file]
docs/interfaces/WorkerChoiceStrategyOptions.html [deleted file]
docs/interfaces/WorkerError.html [deleted file]
docs/interfaces/WorkerInfo.html [deleted file]
docs/interfaces/WorkerNodeEventDetail.html [deleted file]
docs/interfaces/WorkerNodeOptions.html [deleted file]
docs/interfaces/WorkerOptions.html [deleted file]
docs/interfaces/WorkerStatistics.html [deleted file]
docs/interfaces/WorkerUsage.html [deleted file]
docs/interfaces/src.EventLoopUtilizationMeasurementStatistics.html [new file with mode: 0644]
docs/interfaces/src.FixedQueueNode.html [new file with mode: 0644]
docs/interfaces/src.IFixedQueue.html [new file with mode: 0644]
docs/interfaces/src.IPool.html [new file with mode: 0644]
docs/interfaces/src.IWorker.html [moved from docs/interfaces/IWorker.html with 66% similarity]
docs/interfaces/src.IWorkerChoiceStrategy.html [new file with mode: 0644]
docs/interfaces/src.IWorkerNode.html [moved from docs/interfaces/IWorkerNode.html with 61% similarity]
docs/interfaces/src.MeasurementOptions.html [new file with mode: 0644]
docs/interfaces/src.MeasurementStatistics.html [new file with mode: 0644]
docs/interfaces/src.MeasurementStatisticsRequirements.html [new file with mode: 0644]
docs/interfaces/src.MessageValue.html [new file with mode: 0644]
docs/interfaces/src.PoolInfo.html [new file with mode: 0644]
docs/interfaces/src.PoolOptions.html [new file with mode: 0644]
docs/interfaces/src.PromiseResponseWrapper.html [new file with mode: 0644]
docs/interfaces/src.StrategyData.html [new file with mode: 0644]
docs/interfaces/src.StrategyPolicy.html [new file with mode: 0644]
docs/interfaces/src.Task.html [new file with mode: 0644]
docs/interfaces/src.TaskFunctionObject.html [new file with mode: 0644]
docs/interfaces/src.TaskFunctionOperationResult.html [new file with mode: 0644]
docs/interfaces/src.TaskFunctionProperties.html [new file with mode: 0644]
docs/interfaces/src.TaskPerformance.html [new file with mode: 0644]
docs/interfaces/src.TaskStatistics.html [new file with mode: 0644]
docs/interfaces/src.TaskStatisticsRequirements.html [new file with mode: 0644]
docs/interfaces/src.TasksQueueOptions.html [new file with mode: 0644]
docs/interfaces/src.WorkerChoiceStrategyOptions.html [new file with mode: 0644]
docs/interfaces/src.WorkerError.html [new file with mode: 0644]
docs/interfaces/src.WorkerInfo.html [new file with mode: 0644]
docs/interfaces/src.WorkerNodeEventDetail.html [new file with mode: 0644]
docs/interfaces/src.WorkerNodeOptions.html [new file with mode: 0644]
docs/interfaces/src.WorkerOptions.html [new file with mode: 0644]
docs/interfaces/src.WorkerStatistics.html [new file with mode: 0644]
docs/interfaces/src.WorkerUsage.html [new file with mode: 0644]
docs/media/README.md [new file with mode: 0644]
docs/modules/src.html [new file with mode: 0644]
docs/types/ClusterPoolOptions.html [deleted file]
docs/types/ErrorHandler.html [deleted file]
docs/types/EventHandler.html [deleted file]
docs/types/ExitHandler.html [deleted file]
docs/types/KillBehavior.html [deleted file]
docs/types/KillHandler.html [deleted file]
docs/types/Measurement.html [deleted file]
docs/types/MessageHandler.html [deleted file]
docs/types/OnlineHandler.html [deleted file]
docs/types/PoolEvent.html [deleted file]
docs/types/PoolType.html [deleted file]
docs/types/TaskAsyncFunction.html [deleted file]
docs/types/TaskFunction.html [deleted file]
docs/types/TaskSyncFunction.html [deleted file]
docs/types/ThreadPoolOptions.html [deleted file]
docs/types/WorkerType.html [deleted file]
docs/types/Writable.html [deleted file]
docs/types/src.ClusterPoolOptions.html [moved from docs/types/WorkerChoiceStrategy.html with 50% similarity]
docs/types/src.ErrorHandler.html [new file with mode: 0644]
docs/types/src.EventHandler.html [new file with mode: 0644]
docs/types/src.ExitHandler.html [new file with mode: 0644]
docs/types/src.KillBehavior.html [new file with mode: 0644]
docs/types/src.KillHandler.html [new file with mode: 0644]
docs/types/src.Measurement.html [new file with mode: 0644]
docs/types/src.MessageHandler.html [new file with mode: 0644]
docs/types/src.OnlineHandler.html [new file with mode: 0644]
docs/types/src.PoolEvent.html [new file with mode: 0644]
docs/types/src.PoolType.html [new file with mode: 0644]
docs/types/src.TaskAsyncFunction.html [new file with mode: 0644]
docs/types/src.TaskFunction.html [new file with mode: 0644]
docs/types/src.TaskFunctions.html [new file with mode: 0644]
docs/types/src.TaskSyncFunction.html [new file with mode: 0644]
docs/types/src.ThreadPoolOptions.html [new file with mode: 0644]
docs/types/src.WorkerChoiceStrategy.html [new file with mode: 0644]
docs/types/src.WorkerType.html [new file with mode: 0644]
docs/types/src.Writable.html [new file with mode: 0644]
docs/variables/KillBehaviors.html [deleted file]
docs/variables/Measurements.html [deleted file]
docs/variables/PoolEvents.html [deleted file]
docs/variables/PoolTypes.html [deleted file]
docs/variables/WorkerChoiceStrategies.html [deleted file]
docs/variables/WorkerTypes.html [deleted file]
docs/variables/src.KillBehaviors.html [moved from docs/types/TaskFunctions.html with 60% similarity]
docs/variables/src.Measurements.html [new file with mode: 0644]
docs/variables/src.PoolEvents.html [new file with mode: 0644]
docs/variables/src.PoolTypes.html [new file with mode: 0644]
docs/variables/src.WorkerChoiceStrategies.html [new file with mode: 0644]
docs/variables/src.WorkerTypes.html [new file with mode: 0644]