Class default<T>

Promise that can be canceled

Example

Catch CancelError

import CancelablePromise from "@nextgis/cancelable-promise";

const promise = new CancelablePromise((resolve, reject) => {
 setTimeout(() => resolve(), 100);
}).catch((er) => {
 if (er.name === "CancelError") {
   // handle cancel error
 }
 throw er;
});

promise.cancel();

Example

Handle onCancel callback

import CancelablePromise from "@nextgis/cancelable-promise";

const promise = new CancelablePromise((resolve, reject, onCancel) => {
  const xhr = new XMLHttpRequest();
  xhr.open("GET", url, true);
  xhr.onload = () => {
    resolve(xhr.responseText);
  };
  xhr.onerror = (er) => {
    reject(er);
  };

  onCancel(() => {
    xhr.abort();
  });

  xhr.send();
});

promise.cancel();

Type Parameters

  • T = any

Implements

  • Promise<T>

Constructors

constructor

Properties

[toStringTag] id CancelError PromiseControl TimeoutError

Methods

attach cancel catch finally then all createControl reject resolve

Constructors

constructor

  • new default<T>(executor, timeout?): default<T>

  • Type Parameters

    • T = any

    Parameters

    • executor: ((resolve: ((value?: T | PromiseLike<T>) => void), reject: ((reason?: any) => void), onCancel: OnCancelFunction) => void)
        • (resolve, reject, onCancel): void

        • Parameters

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

              • Parameters

                • Optionalvalue: T | PromiseLike<T>

                Returns void

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

              • Parameters

                • Optionalreason: any

                Returns void

          • onCancel: OnCancelFunction

          Returns void

    • Optionaltimeout: number

    Returns default<T>

Properties

Readonly[toStringTag]

[toStringTag]: string

Readonlyid

id: number = ...

StaticCancelError

CancelError: typeof CancelError = CancelError

StaticPromiseControl

PromiseControl: typeof PromiseControl = PromiseControl

StaticTimeoutError

TimeoutError: typeof TimeoutError = TimeoutError

Methods

attach

cancel

catch

  • catch<TResult>(onrejected?): default<T | TResult>

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

    Type Parameters

    • TResult = never

    Parameters

    • Optionalonrejected: null | ((reason: Error) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns default<T | TResult>

    A Promise for the completion of the callback.

finally

  • finally(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

    • Optionalonfinally: null | (() => void)

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

    Returns Promise<T>

    A Promise for the completion of the callback.

then

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

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

    Type Parameters

    • TResult1 = T
    • TResult2 = never

    Parameters

    • Optionalonfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

    Returns default<TResult1 | TResult2>

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

Staticall

  • all<T>(values): default<T[]>

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type Parameters

    • T

    Parameters

    • values: (T | PromiseLike<T>)[]

      An iterable of Promises.

    Returns default<T[]>

    A new Promise.

StaticcreateControl

  • createControl(opt?): PromiseControl

  • Parameters

    • Optionalopt: PromiseControlOptions

    Returns PromiseControl

Staticreject

Staticresolve

Settings

Member Visibility

On This Page

Constructors
Properties
Methods