X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=4e2f3de4f726c9cfbcb6f890e2eee9a514feb859;hb=1d28a82aad237f00542be8b56cc18443a8e87aba;hp=2a2c1993c46b1d378ae23f78138c6e87f0fd9f16;hpb=3d15e8a7b08e6bbe8265793d0fd859d3113c4f4b;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 2a2c1993..4e2f3de4 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,49 +1,32 @@ -import type { Worker } from 'cluster' +import type { Worker as ClusterWorker } from 'cluster' import type { MessagePort } from 'worker_threads' +import type { IWorker } from './pools/abstract-pool' +import type { KillBehavior } from './worker/worker-options' -export type KillBehavior = 'HARD' | 'SOFT' /** - * Make all properties in T non-readonly + * Make all properties in T non-readonly. */ export type Draft = { -readonly [P in keyof T]?: T[P] } -/** - * Serializable primitive JSON value. - */ -export type JSONPrimitive = number | boolean | string | null -/** - * Serializable JSON value. - */ -// eslint-disable-next-line no-use-before-define -export type JSONValue = JSONPrimitive | JSONArray | JSONObject -/** - * Serializable JSON object. - */ -export type JSONObject = { [k: string]: JSONValue } -/** - * Serializable JSON array. - */ -export type JSONArray = Array - /** * Message object that is passed between worker and main worker. */ export interface MessageValue< Data = unknown, - MainWorker extends Worker | MessagePort | unknown = unknown + MainWorker extends ClusterWorker | MessagePort | unknown = unknown > { /** * Input data that will be passed to the worker. */ readonly data?: Data /** - * ID of the message. + * Id of the message. */ readonly id?: number /** * Kill code. */ - readonly kill?: KillBehavior | number + readonly kill?: KillBehavior | 1 /** * Error. */ @@ -51,7 +34,31 @@ export interface MessageValue< /** * Reference to main worker. * - * _Only for internal use_ + * Only for internal use. */ readonly parent?: MainWorker } + +/** + * An object holding the worker that will be used to resolve/rejects the promise later on. + * + * @template Worker Type of worker. + * @template Response Type of response of execution. This can only be serializable data. + */ +export interface PromiseWorkerResponseWrapper< + Worker extends IWorker, + Response = unknown +> { + /** + * Resolve callback to fulfill the promise. + */ + readonly resolve: (value: Response) => void + /** + * Reject callback to reject the promise. + */ + readonly reject: (reason?: string) => void + /** + * The worker that has the assigned task. + */ + readonly worker: Worker +}