X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Findex.html;h=c18f62416d28f63e5f2ec590267d0bacd085b274;hb=90a9a10f90101fa6ad60683f4ce75bb422c8652d;hp=b584827067d7884d0ac564eafa96e1272519d1bb;hpb=849e05470ba75db08bb8def0c547ab4d8c35c9a0;p=poolifier.git diff --git a/docs/index.html b/docs/index.html index b5848270..c18f6241 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,428 +1,17 @@ - - - - - - poolifier - - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - -
-
- Menu -
-
-
-
-
-
-

poolifier

-
-
-
-
-
-
-
-

Index

-
-
-
-

Classes

- -
-
-

Interfaces

- -
-
-

Type aliases

- -
-
-

Variables

- -
-
-
-
-
-

Type aliases

-
- -

ErrorHandler

-
ErrorHandler<Worker>: (this: Worker, e: Error) => void
- -
-
-

Callback invoked if the worker raised an error.

-
-
-

Type parameters

-
    -
  • -

    Worker

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (this: Worker, e: Error): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        this: Worker
        -
        • -
      • -
        e: Error
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

ExitHandler

-
ExitHandler<Worker>: (this: Worker, code: number) => void
- -
-
-

Callback invoked when the worker exits successfully.

-
-
-

Type parameters

-
    -
  • -

    Worker

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (this: Worker, code: number): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        this: Worker
        -
        • -
      • -
        code: number
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

KillBehavior

-
KillBehavior: keyof typeof KillBehaviors
- -
-
-

Kill behavior.

-
-
-
-
- -

OnlineHandler

-
OnlineHandler<Worker>: (this: Worker) => void
- -
-
-

Callback invoked when the worker has started successfully.

-
-
-

Type parameters

-
    -
  • -

    Worker

    -
    • -
-
-

Type declaration

-
    -
  • -
      -
    • (this: Worker): void
      • -
    -
      -
    • -

      Parameters

      -
        -
      • -
        this: Worker
        -
        • -
      -

      Returns void

      -
      • -
    -
    • -
-
-
-
- -

ThreadWorkerWithMessageChannel

-
ThreadWorkerWithMessageChannel: Worker & Draft<MessageChannel>
- -
-
-

A thread worker with message channels for communication between main thread and thread worker.

-
-
-
-
- -

WorkerChoiceStrategy

-
WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies
- -
-
-

Worker choice strategy.

-
-
-
-
-
-

Variables

-
- -

Const KillBehaviors

-
KillBehaviors: Readonly<{ HARD: "HARD"; SOFT: "SOFT" }> = ...
- -
-
-

Enumeration of kill behaviors.

-
-
-
-
- -

Const WorkerChoiceStrategies

-
WorkerChoiceStrategies: Readonly<{ LESS_RECENTLY_USED: "LESS_RECENTLY_USED"; ROUND_ROBIN: "ROUND_ROBIN" }> = ...
- -
-
-

Enumeration of worker choice strategies.

-
-
-
-
-
-
- - -
-
-
- -
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file +poolifier
Options
All
  • Public
  • Public/Protected
  • All
Menu

poolifier

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

ErrorHandler

ErrorHandler<Worker>: (this: Worker, e: Error) => void

Type parameters

  • Worker

Type declaration

    • (this: Worker, e: Error): void
    • +

      Callback invoked if the worker raised an error.

      +

      Parameters

      • this: Worker
      • e: Error

      Returns void

ExitHandler

ExitHandler<Worker>: (this: Worker, code: number) => void

Type parameters

  • Worker

Type declaration

    • (this: Worker, code: number): void
    • +

      Callback invoked when the worker exits successfully.

      +

      Parameters

      • this: Worker
      • code: number

      Returns void

KillBehavior

KillBehavior: keyof typeof KillBehaviors
+

Kill behavior.

+

OnlineHandler

OnlineHandler<Worker>: (this: Worker) => void

Type parameters

  • Worker

Type declaration

    • (this: Worker): void
    • +

      Callback invoked when the worker has started successfully.

      +

      Parameters

      • this: Worker

      Returns void

ThreadWorkerWithMessageChannel

ThreadWorkerWithMessageChannel: Worker & Draft<MessageChannel>
+

A thread worker with message channels for communication between main thread and thread worker.

+

WorkerChoiceStrategy

WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies
+

Worker choice strategy.

+

Variables

KillBehaviors

KillBehaviors: Readonly<{ HARD: "HARD"; SOFT: "SOFT" }> = ...
+

Enumeration of kill behaviors.

+

WorkerChoiceStrategies

WorkerChoiceStrategies: Readonly<{ LESS_RECENTLY_USED: "LESS_RECENTLY_USED"; ROUND_ROBIN: "ROUND_ROBIN" }> = ...
+

Enumeration of worker choice strategies.

+

Generated using TypeDoc

\ No newline at end of file