X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=fba7068053aa10a5bceff53920a743090b826b5b;hb=b667be1103b9362ae29d094de05f812468464d4f;hp=4fad5ee19797fa49ecf9de717a770e4f2c2afadd;hpb=a1e5b51ea192bdcad4751d1f4facc19498ee4f1d;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 4fad5ee1..fba70680 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,4 +1,4 @@ -IWorker | poolifier
+IWorker | poolifier - v2.6.8
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.8
    @@ -17,13 +17,14 @@

    Interface IWorker

    Worker interface.

    -
    +
    +

    Hierarchy

    +
  • Defined in src/pools/worker.ts:176
    • @@ -31,53 +32,132 @@

    Properties

    -
    on -once +
    id? +on +once +threadId?

    Properties

    -
    -

    on

    -
    on: ((event: "message", handler: MessageHandler<IWorker>) => void) & ((event: "error", handler: ErrorHandler<IWorker>) => void) & ((event: "online", handler: OnlineHandler<IWorker>) => void) & ((event: "exit", handler: ExitHandler<IWorker>) => void)
    -

    Register an event listener.

    - -

    Param

    The event.

    +
    +

    Optional Readonly id

    +
    id?: number
    +

    Worker id.

    +
    +
    +
    +

    on

    +
    on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void)
    +

    Registers an event listener.

    +
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (event, handler): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Type declaration

    +
      +
    • +
        +
      • (event, handler): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Type declaration

    +
      +
    • +
        +
      • (event, handler): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Type declaration

    +
      +
    • +
        +
      • (event, handler): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Param

    The event.

    -

    Param

    The event listener.

    +

    Param

    The event handler.

    -
    -

    once

    -
    once: ((event: "exit", handler: ExitHandler<IWorker>) => void)
    +
  • Defined in src/pools/worker.ts:188
    • +
    +

    once

    +
    once: ((event, handler) => void)

    Type declaration

    • -
        -
      • (event: "exit", handler: ExitHandler<IWorker>): void
        • +
          +
        • (event, handler): void
        • -

          Register a listener to the exit event that will only performed once.

          +

          Registers a listener to the exit event that will only be performed once.

          Parameters

          • -
            event: "exit"
            +
            event: "exit"

            'exit'.

            -
            • +
          +
        • -
          handler: ExitHandler<IWorker>
          +
          handler: ExitHandler<IWorker>

          The exit handler.

          -
    -

    Returns void

    +
    +

    Optional Readonly threadId

    +
    threadId?: number
    +
  • Defined in src/pools/worker.ts:181
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -87,54 +167,77 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • id
    • +
  • on
    • +
  • once
    • +
  • threadId
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • EventLoopUtilizationMeasurementStatistics
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MeasurementOptions
    • +
  • MeasurementStatistics
    • +
  • MeasurementStatisticsRequirements
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • StrategyPolicy
    • +
  • Task
    • +
  • TaskError
    • +
  • TaskPerformance
    • +
  • TaskStatistics
    • +
  • TaskStatisticsRequirements
    • +
  • TasksQueueOptions
    • +
  • ThreadPoolOptions
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerInfo
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • WorkerStatistics
    • +
  • WorkerUsage
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskFunctions
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file