X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=2fcb0676ff5da98ccf5efbd2b54726b884d54492;hb=adab53c70d781f8c26e35b7359efa3d05c278fa8;hp=93b55d6d42889edea3ee0f7dc8e71039db55b680;hpb=953288ed6e2b952fb17b6fb0ebc4188ce813d53b;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 93b55d6d..2fcb0676 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v2.6.31
+ThreadWorker | poolifier - v2.6.39
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.31
+
  • The search index is not available
  • poolifier - v2.6.39
    @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

    • ThreadWorker
    +
  • Defined in src/worker/thread-worker.ts:26
  • @@ -117,18 +117,16 @@ but the minimum number of workers will be guaranteed.

  • taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    -
    -
  • +
  • opts: WorkerOptions = {}

    Options for the worker.

    -
    -
  • +

    Returns ThreadWorker<Data, Response>

    +
  • Defined in src/worker/thread-worker.ts:40
  • Properties

    @@ -139,7 +137,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:73
  • isMain: boolean
    @@ -148,7 +146,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:85
  • lastTaskTimestamp: number
    @@ -157,7 +155,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:65
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -166,7 +164,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:88
  • port: MessagePort
    @@ -174,7 +172,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/thread-worker.ts:33
  • statistics: WorkerStatistics
    @@ -183,7 +181,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:69
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -192,7 +190,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:61
  • Accessors

    @@ -206,7 +204,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/thread-worker.ts:86
  • Methods

    @@ -223,13 +221,11 @@ If a task function with the same name already exists, it is replaced.

  • name: string

    The name of the task function to add.

    -
    -
  • +
  • fn: TaskFunction<Data, Response>

    The task function to add.

    -
    -
  • +

    Returns boolean

    Whether the task function was added or not.

    @@ -241,7 +237,7 @@ If a task function with the same name already exists, it is replaced.

    +
  • Defined in src/worker/abstract-worker.ts:193
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:306
  • +

    Returns Func

    Since

    v14.8.0, v12.19.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:283
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:302
  • +
  • Defined in src/worker/abstract-worker.ts:434
  • +

    Returns string

    The error message.

    +
  • Defined in src/worker/thread-worker.ts:96
  • +

    Returns void

    +
  • Defined in src/worker/thread-worker.ts:79
  • +

    Returns void

    +
  • Defined in src/worker/thread-worker.ts:54
  • +

    Returns boolean

    Whether the worker has a task function with the given name or not.

    @@ -392,7 +385,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:255
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:329
  • +

    Returns boolean

    Whether the task function existed and was removed or not.

    @@ -452,7 +443,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:231
  • +

    Returns void

    Throws

    https://nodejs.org/api/errors.html#class-error If the task function is not found.

    +
  • Defined in src/worker/abstract-worker.ts:476
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:541
  • Optional thisArg: This

    The receiver to be used for the function call.

    -
    -
  • +Optional
  • Rest ...args: any[]

    Optional arguments to pass to the function.

    -
    -
  • +Rest

    Returns Result

    Since

    v9.6.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:294
  • +

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:504
  • +
  • Defined in src/worker/abstract-worker.ts:453
  • +

    Returns void

    +
  • Defined in src/worker/thread-worker.ts:91
  • +

    Returns boolean

    Whether the default task function was set or not.

    @@ -638,7 +619,7 @@ then restore the original execution context.

    +
  • Defined in src/worker/abstract-worker.ts:285
  • +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:311
  • +
    Optional thisArg: ThisArg
    Optional

    Returns Func

    Since

    v14.8.0, v12.19.0

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.7/node_modules/@types/node/async_hooks.d.ts:277
  • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file