X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPromiseResponseWrapper.html;h=bdbe4de74226d1a5d363c26d5d66240f21a854f5;hb=afa30fd0dd5bbc5d305cc30be663966a449efc08;hp=faed5d814e62e2c3e92bf2a70889fbe2c467851f;hpb=56960396878dec81e3ebeea5b76387efca8cc2dc;p=poolifier.git diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index faed5d81..bdbe4de7 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -1,4 +1,4 @@ -PromiseResponseWrapper | poolifier
+PromiseResponseWrapper | poolifier

An object holding the execution response promise resolve/reject callbacks.

-
-
+
+
+

Type Parameters

-
    +
    • -

      Worker extends IWorker

      +

      Worker extends IWorker

      Type of worker.

      -
      • + +
    • -

      Response = unknown

      +

      Response = unknown

      Type of execution response. This can only be serializable data.

      -
+ +

Hierarchy

  • PromiseResponseWrapper
+
  • Defined in src/utility-types.ts:75
    • @@ -42,21 +45,21 @@

    Properties

    -
    reject -resolve -worker +
    reject +resolve +worker

    Properties

    -
    -

    Readonly reject

    -
    reject: ((reason?: string) => void)
    +
    +

    Readonly reject

    +
    reject: ((reason?) => void)

    Type declaration

    • -
        -
      • (reason?: string): void
        • +
          +
        • (reason?): void

        • Reject callback to reject the promise.

          @@ -64,19 +67,20 @@

          Parameters

          • -
            Optional reason: string
    -

    Returns void

    -
    -

    Readonly resolve

    -
    resolve: ((value: Response) => void)
    +
  • Defined in src/utility-types.ts:86
    • +
    +

    Readonly resolve

    +
    resolve: ((value) => void)

    Type declaration

    • -
        -
      • (value: Response): void
        • +
          +
        • (value): void

        • Resolve callback to fulfill the promise.

          @@ -84,22 +88,24 @@

          Parameters

          • -
            value: Response
    -

    Returns void

    -
    -

    Readonly worker

    -
    worker: Worker
    +
  • Defined in src/utility-types.ts:82
    • +
    +

    Readonly worker

    +
    worker: Worker

    The worker handling the execution.

    -
    +
  • Defined in src/utility-types.ts:90
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -109,55 +115,64 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • reject
    • +
  • resolve
    • +
  • worker
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • Task
    • +
  • TaskStatistics
    • +
  • TasksQueueOptions
    • +
  • TasksUsage
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • Draft
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskFunctions
    • +
  • ThreadWorkerWithMessageChannel
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes

    • Generated using TypeDoc

    \ No newline at end of file