Class Task<T>

Task represents the task to run for the QueueTaskRunner.

Type Parameters

  • T

Hierarchy

  • Task

Constructors

  • Type Parameters

    • T

    Parameters

    • func: (() => Promise<T>)
        • (): Promise<T>
        • Returns Promise<T>

    • resolve: ((value: T | PromiseLike<T>) => void)
        • (value: T | PromiseLike<T>): void
        • Parameters

          • value: T | PromiseLike<T>

          Returns void

    • reject: ((reason?: unknown) => void)
        • (reason?: unknown): void
        • Parameters

          • Optional reason: unknown

          Returns void

    • resultPromise: Promise<T>
    • Optional ttlEpochMillisec: number

    Returns Task<T>

Properties

func: (() => Promise<T>)

Type declaration

    • (): Promise<T>
    • Returns Promise<T>

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

Type declaration

    • (reason?: unknown): void
    • Parameters

      • Optional reason: unknown

      Returns void

resolve: ((value: T | PromiseLike<T>) => void)

Type declaration

    • (value: T | PromiseLike<T>): void
    • Parameters

      • value: T | PromiseLike<T>

      Returns void

resultPromise: Promise<T>
ttlEpochMillisec?: number

Methods

  • Returns Promise<void>

  • getResult returns a Promise that represents the result of run this task.

    Returns Promise<T>

  • make makes a new instance of the Task.

    Type Parameters

    • T

    Parameters

    • func: (() => Promise<T>)

      a procedure to run

        • (): Promise<T>
        • Returns Promise<T>

    • Optional ttlEpochMillisec: number

      TTL epoch milliseconds for the task

    Returns Promise<Task<T>>

Generated using TypeDoc