X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=f13cce6a70d9f60ed7417b9d2a45675c5179fb72;hb=7169bda30538a5244b2598a4ef466c5687953ebd;hp=b3cea1a1516004b18b757333b71853c3faa35f8b;hpb=6a3ecc500583fc68d5bbce89f8448ccd022ab900;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index b3cea1a1..f13cce6a 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -2,11 +2,11 @@ import type { AsyncResource } from 'node:async_hooks' import type { EventLoopUtilization } from 'node:perf_hooks' import type { MessagePort, TransferListItem } from 'node:worker_threads' +import type { WorkerChoiceStrategy } from './pools/selection-strategies/selection-strategies-types.js' import type { KillBehavior } from './worker/worker-options.js' /** * Worker error. - * * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. */ export interface WorkerError { @@ -26,7 +26,6 @@ export interface WorkerError { /** * Task performance. - * * @internal */ export interface TaskPerformance { @@ -50,7 +49,6 @@ export interface TaskPerformance { /** * Worker task performance statistics computation settings. - * * @internal */ export interface WorkerStatistics { @@ -64,9 +62,26 @@ export interface WorkerStatistics { readonly elu: boolean } +/** + * Task function properties. + */ +export interface TaskFunctionProperties { + /** + * Task function name. + */ + readonly name: string + /** + * Task function priority. Lower values have higher priority. + */ + readonly priority?: number + /** + * Task function worker choice strategy. + */ + readonly strategy?: WorkerChoiceStrategy +} + /** * Message object that is passed as a task between main worker and worker. - * * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ @@ -79,6 +94,15 @@ export interface Task { * Task input data that will be passed to the worker. */ readonly data?: Data + /** + * Task priority. Lower values have higher priority. + * @defaultValue 0 + */ + readonly priority?: number + /** + * Task worker choice strategy. + */ + readonly strategy?: WorkerChoiceStrategy /** * Array of transferable objects. */ @@ -90,12 +114,11 @@ export interface Task { /** * Task UUID. */ - readonly taskId?: string + readonly taskId?: `${string}-${string}-${string}-${string}-${string}` } /** * Message object that is passed between main worker and worker. - * * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data. * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. * @internal @@ -130,17 +153,17 @@ export interface MessageValue */ readonly taskFunctionOperationStatus?: boolean /** - * Task function serialized to string. + * Task function properties. */ - readonly taskFunction?: string + readonly taskFunctionProperties?: TaskFunctionProperties /** - * Task function name. + * Task function serialized to string. */ - readonly taskFunctionName?: string + readonly taskFunction?: string /** - * Task function names. + * Task functions properties. */ - readonly taskFunctionNames?: string[] + readonly taskFunctionsProperties?: TaskFunctionProperties[] /** * Whether the worker computes the given statistics or not. */ @@ -161,7 +184,6 @@ export interface MessageValue /** * An object holding the task execution response promise resolve/reject callbacks. - * * @typeParam Response - Type of execution response. This can only be structured-cloneable data. * @internal */