X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2Fipool.html;h=f5acef7dd5bef9c744210c97a935851cfe91b4f0;hb=0136f64e4790627dd07ec018e9c2e4cd8888191e;hp=dd2238e1aea64064bd5b6dc5beace05d9537e045;hpb=849e05470ba75db08bb8def0c547ab4d8c35c9a0;p=poolifier.git diff --git a/docs/interfaces/ipool.html b/docs/interfaces/ipool.html index dd2238e1..f5acef7d 100644 --- a/docs/interfaces/ipool.html +++ b/docs/interfaces/ipool.html @@ -1,330 +1,18 @@ - - - - - - IPool | poolifier - - - - - - -

- -

-

- -

Interface IPool<Data, Response>

-

-

-

-

-

-

-

-

-

-

Contract definition for a poolifier pool.

-

-

-

-

-

Type parameters

-

-
Data = unknown
-
-
-
Type of data sent to the worker. This can only be serializable data.
-
-
-
-
Response = unknown
-
-
-
Type of response of execution. This can only be serializable data.
-
-
-

-

-

-

Hierarchy

-

- IPool -

-

-

-

Index

-

-

-

-

Methods

-

-

-

-

-

-

-

Methods

-

- -

destroy

-

destroy(): Promise<void>

-

-
-
- Defined in src/pools/pool.ts:20
-
-
-
-
Shut down every current worker in this pool.
-
-
-
Returns Promise<void>
-

-

-

- -

execute

-

execute(data: Data): Promise<Response>

-

-
-
- Defined in src/pools/pool.ts:16
-
-
-
-
Perform the task specified in the constructor with the data parameter.
-
-
-
Parameters
-
- -
  data: Data
  -
  -
  The input for the specified task. This can only be serializable data.
  -
  -
-
Returns Promise<Response>
-
Promise that will be resolved when the task is successfully completed.
-

-

-

- -

setWorkerChoiceStrategy

-

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"): void

-

-
-
- Defined in src/pools/pool.ts:26
-
-
-
-
Set the worker choice strategy in this pool.
-
-
-
Parameters
-
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
  -
  -
  The worker choice strategy.
  -
  -
-
Returns void
-

-

-

-

- -

-

- -

-

Generated using TypeDoc

-

-

- - - \ No newline at end of file +IPool | poolifier

Interface IPool<Data, Response>

+

Contract definition for a poolifier pool.

+

Type parameters

Data = unknown
+
Type of data sent to the worker. This can only be serializable data.
+
Response = unknown
+
Type of response of execution. This can only be serializable data.
+

Hierarchy

IPool

Index

Methods

Methods

destroy

destroy(): Promise<void>

- Defined in src/pools/pool.ts:20
+
Shut down every current worker in this pool.
+
Returns Promise<void>

execute

execute(data: Data): Promise<Response>

- Defined in src/pools/pool.ts:16
+
Perform the task specified in the constructor with the data parameter.
+
Parameters
- data: Data
  +
  The input for the specified task. This can only be serializable data.
  +
Returns Promise<Response>
Promise that will be resolved when the task is successfully completed.
+

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"): void

- Defined in src/pools/pool.ts:26
+
Set the worker choice strategy in this pool.
+
Parameters
- workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
  +
  The worker choice strategy.
  +
Returns void

Generated using TypeDoc

\ No newline at end of file