From: Jérôme Benoit Date: Sat, 8 Oct 2022 16:49:16 +0000 (+0200) Subject: Add missed documentation files X-Git-Tag: v2.2.1~4 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=671da6812a80aa033463c6605e7a3427c68a38fc;p=poolifier.git Add missed documentation files Signed-off-by: Jérôme Benoit --- diff --git a/docs/interfaces/IPoolWorker.html b/docs/interfaces/IPoolWorker.html new file mode 100644 index 00000000..b2fd93fa --- /dev/null +++ b/docs/interfaces/IPoolWorker.html @@ -0,0 +1,176 @@ +IPoolWorker | poolifier
+
+ +
+
+
+
+ +

Interface IPoolWorker

+
+

Basic interface that describes the minimum required implementation of listener events for a pool worker.

+
+
+

Hierarchy

+
    +
  • IPoolWorker
+
+
+
+ +
+
+

Properties

+
id? +
+
+

Methods

+
on +once +
+
+

Properties

+
+

Optional Readonly id

+
id?: number
+

Worker identifier.

+
+
+

Methods

+
+

on

+
+
+

once

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html new file mode 100644 index 00000000..b568bafb --- /dev/null +++ b/docs/types/ErrorHandler.html @@ -0,0 +1,86 @@ +ErrorHandler | poolifier
+
+ +
+
+
+
+ +

Type alias ErrorHandler<Worker>

+
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

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html new file mode 100644 index 00000000..8b3f3542 --- /dev/null +++ b/docs/types/ExitHandler.html @@ -0,0 +1,86 @@ +ExitHandler | poolifier
+
+ +
+
+
+
+ +

Type alias ExitHandler<Worker>

+
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

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html new file mode 100644 index 00000000..5acab62c --- /dev/null +++ b/docs/types/KillBehavior.html @@ -0,0 +1,66 @@ +KillBehavior | poolifier
+
+ +
+
+
+
+ +

Type alias KillBehavior

+
KillBehavior: keyof typeof KillBehaviors
+

Kill behavior.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html new file mode 100644 index 00000000..9a7e928d --- /dev/null +++ b/docs/types/OnlineHandler.html @@ -0,0 +1,84 @@ +OnlineHandler | poolifier
+
+ +
+
+
+
+ +

Type alias OnlineHandler<Worker>

+
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

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html new file mode 100644 index 00000000..7399306f --- /dev/null +++ b/docs/types/ThreadWorkerWithMessageChannel.html @@ -0,0 +1,66 @@ +ThreadWorkerWithMessageChannel | poolifier
+
+ +
+
+
+
+ +

Type alias ThreadWorkerWithMessageChannel

+
ThreadWorkerWithMessageChannel: Worker & Draft<MessageChannel>
+

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

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html new file mode 100644 index 00000000..0ac940e4 --- /dev/null +++ b/docs/types/WorkerChoiceStrategy.html @@ -0,0 +1,66 @@ +WorkerChoiceStrategy | poolifier
+
+ +
+
+
+
+ +

Type alias WorkerChoiceStrategy

+
WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies
+

Worker choice strategy.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html new file mode 100644 index 00000000..ffd3bbf8 --- /dev/null +++ b/docs/variables/KillBehaviors.html @@ -0,0 +1,66 @@ +KillBehaviors | poolifier
+
+ +
+
+
+
+ +

Variable KillBehaviorsConst

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

Enumeration of kill behaviors.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html new file mode 100644 index 00000000..7fc703f6 --- /dev/null +++ b/docs/variables/WorkerChoiceStrategies.html @@ -0,0 +1,66 @@ +WorkerChoiceStrategies | poolifier
+
+ +
+
+
+
+ +

Variable WorkerChoiceStrategiesConst

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

Enumeration of worker choice strategies.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file