Class Abortable<T>

Type Parameters

  • T = void

Hierarchy

Constructors

constructor

Properties

_reject _resolve abortController boundCatch boundFinally boundThen

Accessors

[toStringTag] catch finally then

Methods

abort reject resolve

Constructors

constructor

  • Type Parameters

    • T = void

    Parameters

    • callback: ((resolve, reject, abortController) => void)
        • (resolve, reject, abortController): void

        • Parameters

          • resolve: ((value) => void)
              • (value): void

              • Parameters

                • value: T

                Returns void

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

              • Parameters

                • Optional reason: Error

                Returns void

          • abortController: AbortController

          Returns void

    • Optional abortController: AbortController

    Returns Abortable<T>

Properties

Protected _reject

_reject: ((reason) => void)

Type declaration

    • (reason): void

    • Parameters

      • reason: unknown

      Returns void

Protected _resolve

_resolve: ((value) => void)

Type declaration

    • (value): void

    • Parameters

      • value: T

      Returns void

Private Readonly abortController

abortController: any

Protected Readonly boundCatch

boundCatch: (<TResult>(onrejected?) => Promise<T | TResult>)

Type declaration

    • <TResult>(onrejected?): Promise<T | TResult>

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

      Type Parameters

      • TResult = never

      Parameters

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

        The callback to execute when the Promise is rejected.

          • (reason): TResult | PromiseLike<TResult>

          • Parameters

            • reason: any

            Returns TResult | PromiseLike<TResult>

      Returns Promise<T | TResult>

      A Promise for the completion of the callback.

Protected Readonly boundFinally

boundFinally: ((onfinally?) => Promise<T>)

Type declaration

    • (onfinally?): Promise<T>

    • 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: (() => void)

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

          • (): void

          • Returns void

      Returns Promise<T>

      A Promise for the completion of the callback.

Protected Readonly boundThen

boundThen: (<TResult1, TResult2>(onfulfilled?, onrejected?) => Promise<TResult1 | TResult2>)

Type declaration

    • <TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>

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

      Type Parameters

      • TResult1 = T

      • TResult2 = never

      Parameters

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

        The callback to execute when the Promise is resolved.

          • (value): TResult1 | PromiseLike<TResult1>

          • Parameters

            • value: T

            Returns TResult1 | PromiseLike<TResult1>

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

        The callback to execute when the Promise is rejected.

          • (reason): TResult2 | PromiseLike<TResult2>

          • Parameters

            • reason: any

            Returns TResult2 | PromiseLike<TResult2>

      Returns Promise<TResult1 | TResult2>

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

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

catch

  • get catch(): (<TResult>(onrejected?) => Promise<T | TResult>)

  • Returns (<TResult>(onrejected?) => Promise<T | TResult>)

      • <TResult>(onrejected?): Promise<T | TResult>

      • Type Parameters

        • TResult = never

        Parameters

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

            • Parameters

              • reason: any

              Returns TResult | PromiseLike<TResult>

        Returns Promise<T | TResult>

finally

  • get finally(): ((onfinally?) => Promise<T>)

  • Returns ((onfinally?) => Promise<T>)

      • (onfinally?): Promise<T>

      • Parameters

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

            • Returns void

        Returns Promise<T>

then

  • get then(): (<TResult1, TResult2>(onfulfilled?, onrejected?) => Promise<TResult1 | TResult2>)

  • Returns (<TResult1, TResult2>(onfulfilled?, onrejected?) => Promise<TResult1 | TResult2>)

      • <TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>

      • Type Parameters

        • TResult1 = T

        • TResult2 = never

        Parameters

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

            • Parameters

              • value: T

              Returns TResult1 | PromiseLike<TResult1>

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

            • Parameters

              • reason: any

              Returns TResult2 | PromiseLike<TResult2>

        Returns Promise<TResult1 | TResult2>

Methods

abort

  • Parameters

    • Optional reason: Error

    Returns void

Static reject

  • Type Parameters

    • T

    Parameters

    • Optional reason: Error

    Returns Abortable<T>

Static resolve

  • Returns Abortable<void>

  • Type Parameters

    • R

    Parameters

    • value: R

    Returns Abortable<R>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc