X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FTask.html;h=1d9a2d013d3875ac26771dc3dcf740f630b7cb86;hb=2493c34370d0839614058bb55254fd7aec91b664;hp=fa5f0d09b86536bff3f00d78c5952aadd3ea1f51;hpb=e82ac13a1f1af55b7668013195a12f9e3e017205;p=poolifier.git diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index fa5f0d09..1d9a2d01 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,154 +1,19 @@ -Task | poolifier - v3.0.3
-
- -
-
-
-
- -

Interface Task<Data>Internal

-
-

Message object that is passed as a task between main worker and worker.

-
-
-
-

Type Parameters

-
    -
  • -

    Data = unknown

    -

    Type of data sent to the worker. This can only be structured-cloneable data.

    -
    -
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
data? -name? -taskId? -timestamp? -transferList? -workerId? -
-
-

Properties

-
-

Optional Readonly data

-
data?: Data
-

Task input data that will be passed to the worker.

-
-
-
-

Optional Readonly name

-
name?: string
-

Task name.

-
-
-
-

Optional Readonly taskId

-
taskId?: string
-

Task UUID.

-
-
-
-

Optional Readonly timestamp

-
timestamp?: number
-

Timestamp.

-
-
-
-

Optional Readonly transferList

-
transferList?: TransferListItem[]
-

Array of transferable objects.

-
-
-
-

Optional Readonly workerId

-
workerId?: number
-

Worker id.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +Task | poolifier - v4.0.11

Interface Task<Data>Internal

Message object that is passed as a task between main worker and worker.

+
interface Task<Data> {
    data?: Data;
    name?: string;
    priority?: number;
    strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    taskId?: `${string}-${string}-${string}-${string}-${string}`;
    timestamp?: number;
    transferList?: readonly TransferListItem[];
}

Type Parameters

  • Data = unknown

    Type of data sent to the worker. This can only be structured-cloneable data.

    +

Hierarchy (view full)

Properties

data? +name? +priority? +strategy? +taskId? +timestamp? +transferList? +

Properties

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

+

Optional Readonly name

name?: string

Task name.

+

Optional Readonly priority

priority?: number

Task priority. Lower values have higher priority.

+

Default Value

0
+
+

Optional Readonly strategy

strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Task worker choice strategy.

+

Optional Readonly taskId

taskId?: `${string}-${string}-${string}-${string}-${string}`

Task UUID.

+

Optional Readonly timestamp

timestamp?: number

Timestamp.

+

Optional Readonly transferList

transferList?: readonly TransferListItem[]

Array of transferable objects.

+

Settings

Member Visibility

Theme

On This Page

datanameprioritystrategytaskIdtimestamptransferList
\ No newline at end of file