X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=171b0c64063e4b200ea46b40bdd890fe8b835bf3;hb=6047493a00c2852f2c7f4329def8e1322c678cf1;hp=5ff29d945688f69d7286b7924b37b4433ecb8a6d;hpb=ed1ecf09c599769ed61771ec25d71c39c19ba70b;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 5ff29d94..171b0c64 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,15 @@ -AbstractWorker | poolifier
+AbstractWorker | poolifier
-
+
-
+
+
  • Defined in src/worker/abstract-worker.ts:19
    • @@ -54,9 +56,10 @@

    Properties

    aliveInterval? +isMain lastTaskTimestamp mainWorker -opts +opts

    Methods

    @@ -81,7 +84,7 @@

    constructor

      - +

    • Constructs a new poolifier worker.

      @@ -106,60 +109,69 @@

      Whether this is the main worker or not.

    • -
      fn: ((data: Data) => Response)
      +
      fn: ((data: Data) => Response | Promise<Response>)

      Function processed by the worker when the pool's execution function is invoked.

        • -
        • (data: Data): Response
          • +
        • (data: Data): Response | Promise<Response>

        • Parameters

          • -
            data: Data
          -

          Returns Response

      • +
      data: Data
    +

    Returns Response | Promise<Response>

  • -
    mainWorker: undefined | null | MainWorker
    +
    mainWorker: undefined | null | MainWorker

    Reference to main worker.

  • opts: WorkerOptions = ...

    Options for the worker.

    • -

    Returns AbstractWorker<MainWorker, Data, Response>

    Properties

    Protected Optional Readonly aliveInterval

    aliveInterval?: Timeout
    -

    Handler Id of the aliveInterval worker alive check.

    +

    Handler id of the aliveInterval worker alive check.

    +
  • Defined in src/worker/abstract-worker.ts:31
    • +
    +

    Protected Readonly isMain

    +
    isMain: boolean
    +

    Whether this is the main worker or not.

    +

    Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +
  • Defined in src/worker/abstract-worker.ts:27

    • Protected mainWorker

    -
    mainWorker: undefined | null | MainWorker
    -
    -

    Readonly opts

    -
    opts: WorkerOptions
    +
  • Defined in src/worker/abstract-worker.ts:45
    • +
    +

    Protected Readonly opts

    +
    opts: WorkerOptions = ...

    Options for the worker.

    +
  • Defined in src/worker/abstract-worker.ts:46

    • Methods

    @@ -173,11 +185,11 @@

    Returns number

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315

    • bind

      - +

    • Binds the given function to execute to this AsyncResource's scope.

      The returned function will have an asyncResource property referencing @@ -194,51 +206,51 @@ the AsyncResource to which the function is bound.

      Parameters

      • -
        fn: Func
        +
        fn: Func

        The function to bind to the current AsyncResource.

      -

      Returns Func & { asyncResource: AsyncResource }

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288

    • Protected checkAlive

    • -

      Check to see if the worker should be terminated, because its living too long.

      +

      Checks if the worker should be terminated, because its living too long.

      Returns void

    +
  • Defined in src/worker/abstract-worker.ts:153

    • Private checkFunctionInput

      - +
    • -

      Check if the fn parameter is passed to the constructor.

      +

      Checks if the fn parameter is passed to the constructor.

      Parameters

      • -
        fn: ((data: Data) => Response)
        +
        fn: ((data: Data) => Response | Promise<Response>)

        The function that should be defined.

          • -
          • (data: Data): Response
            • +
          • (data: Data): Response | Promise<Response>

          • Parameters

            • -
              data: Data
            -

            Returns Response

      +
      data: Data
    +

    Returns Response | Promise<Response>

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:117

    • Private checkWorkerOptions

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:105

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311

    • Protected getMainWorker

    +
  • Defined in src/worker/abstract-worker.ts:136

    • Protected handleError

    Returns string

    +
  • Defined in src/worker/abstract-worker.ts:168

    • Protected messageListener

    +

    Returns Response | Promise<Response>

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:84

    • Protected run

  • -
    value: MessageValue<Data, unknown>
    +
    message: MessageValue<Data, unknown>

    Input data for the given function.

    • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:178

    • Protected runAsync

  • -
    value: MessageValue<Data, unknown>
    +
    message: MessageValue<Data, unknown>

    Input data for the given function.

    • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:205

    • runInAsyncScope

  • -
    Optional thisArg: This
    +
    Optional thisArg: This

    The receiver to be used for the function call.

  • Rest ...args: any[]

    Optional arguments to pass to the function.

    • -

    Returns Result

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303

    • Protected Abstract sendToMainWorker

    +
  • Defined in src/worker/abstract-worker.ts:148

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320

    • Static bind

    Parameters

    -

    Returns Func & { asyncResource: AsyncResource }

    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -518,37 +537,72 @@ the AsyncResource to which the function is bound.

    • Theme

    - -
    -
    +
  • constructor
    • +
  • aliveInterval
    • +
  • isMain
    • +
  • lastTaskTimestamp
    • +
  • mainWorker
    • +
  • opts
    • +
  • asyncId
    • +
  • bind
    • +
  • checkAlive
    • +
  • checkFunctionInput
    • +
  • checkWorkerOptions
    • +
  • emitDestroy
    • +
  • getMainWorker
    • +
  • handleError
    • +
  • messageListener
    • +
  • run
    • +
  • runAsync
    • +
  • runInAsyncScope
    • +
  • sendToMainWorker
    • +
  • triggerAsyncId
    • +
  • bind
    • +
    +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file