Interface TaskPromise<TResult, TProgress>

Type Parameters

  • TResult

  • TProgress = unknown

Hierarchy

  • Promise<TResult>
    • TaskPromise

Implemented by

Properties

[toStringTag] hasError isFinished isRunning

Methods

cancel catch finally on then

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly hasError

hasError: boolean

Readonly isFinished

isFinished: boolean

Readonly isRunning

isRunning: boolean

Methods

cancel

catch

  • Attaches a callback for only the rejection of the Promise.

    Type Parameters

    • TResult = never

    Parameters

    • Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult | TResult>

    A Promise for the completion of the callback.

finally

  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Parameters

    • Optional onfinally: null | (() => void)

      The callback to execute when the Promise is settled (fulfilled or rejected).

    Returns Promise<TResult>

    A Promise for the completion of the callback.

on

  • Type Parameters

    • K extends keyof TaskEvents<TResult, TProgress>

    Parameters

    • event: K
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: TaskEvents<TResult, TProgress>[K]

          Returns void

    Returns TaskPromise<TResult, TProgress>

then

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type Parameters

    • TResult1 = TResult

    • TResult2 = never

    Parameters

    • Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Settings

Member Visibility

Theme

On This Page