X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FTask.html;h=3d0ef9a7a1d9093601c2d404bebc1cfa79ba71b1;hb=224d008191f52fa20b93e1ba67919569f8d6e315;hp=787abddbf51af0f61a5a4bd01e8dc4f3f37ab41f;hpb=dea42379cfdbcf1c1c9800df7c097eab484ebc07;p=poolifier.git diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 787abddb..3d0ef9a7 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,19 +1,20 @@ -Task | poolifier - v4.0.15

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? +Task | poolifier - v4.0.15

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 +

Properties

Optional Readonlydata

data?: Data

Task input data that will be passed to the worker.

+

Optional Readonlyname

name?: string

Task name.

+

Optional Readonlypriority

priority?: number

Task priority. Lower values have higher priority.

+

Default Value

0
+
+ +

Optional Readonlystrategy

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

Task worker choice strategy.

+

Optional ReadonlytaskId

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

Task UUID.

+

Optional Readonlytimestamp

timestamp?: number

Timestamp.

+

Optional ReadonlytransferList

transferList?: readonly TransferListItem[]

Array of transferable objects.

+

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file