X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Fdynamic.ts;h=8b8c5185772dbea59bc0d22b2e1cb90b9383d507;hb=1d71a90829622a3541c2530c90b208e9e72ba9ec;hp=33497b0314ef1e46eb3bd129557f31b5e5f4cc17;hpb=7c0ba92006a5c188738ffc5ff642c51f172df3d6;p=poolifier.git diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts index 33497b03..8b8c5185 100644 --- a/src/pools/cluster/dynamic.ts +++ b/src/pools/cluster/dynamic.ts @@ -8,9 +8,8 @@ import { FixedClusterPool } from './fixed' * This cluster pool creates new workers when the others are busy, up to the maximum number of workers. * When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`. * - * @template Data Type of data sent to the worker. This can only be serializable data. - * @template Response Type of response of execution. This can only be serializable data. - * + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Response - Type of response of execution. This can only be serializable data. * @author [Christopher Quadflieg](https://github.com/Shinigami92) * @since 2.0.0 */ @@ -21,26 +20,26 @@ export class DynamicClusterPool< /** * Constructs a new poolifier dynamic cluster pool. * - * @param min Minimum number of workers which are always active. - * @param max Maximum number of workers that can be created by this pool. - * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute. - * @param opts Options for this dynamic cluster pool. Default: `{}` + * @param min - Minimum number of workers which are always active. + * @param max - Maximum number of workers that can be created by this pool. + * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute. + * @param opts - Options for this dynamic cluster pool. */ public constructor ( min: number, - public readonly max: number, + protected readonly max: number, filePath: string, opts: ClusterPoolOptions = {} ) { super(min, filePath, opts) } - /** @inheritdoc */ + /** {@inheritDoc} */ public get type (): PoolType { return PoolType.DYNAMIC } - /** @inheritdoc */ + /** {@inheritDoc} */ public get busy (): boolean { return this.workers.length === this.max }