Class APIPromise<T>

constructor

• new APIPromise<T>(
      p: [T, APICall] | Promise<[T, APICall]>,
      callSource?: Promise<APICall>,
  ): APIPromise<T>

  Type Parameters

  • T

  Parameters

  • p: [T, APICall] | Promise<[T, APICall]>
  • OptionalcallSource: Promise<APICall>

  Returns APIPromise<T>

_callSource

Readonly_promise

_unwrapped

Readonly[toStringTag]

_getUnwrapped

• _getUnwrapped(): Promise<T>

  Returns Promise<T>

_thenUnwrap

• _thenUnwrap<U>(transform: (value: T) => U): APIPromise<U>

  Type Parameters

  • U

  Parameters

  • transform: (value: T) => U

  Returns APIPromise<U>

$inspect

• $inspect(): Promise<[T, APICall]>

  Returns Promise<[T, APICall]>

asResponse

• asResponse(): Promise<Response>

  Returns Promise<Response>

catch

• catch<TResult = never>(
      onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>,
  ): Promise<T | TResult>

  Attaches a callback for only the rejection of the Promise.

  Type Parameters

  • TResult = never

  Parameters

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

    The callback to execute when the Promise is rejected.

  Returns Promise<T | TResult>

  A Promise for the completion of the callback.

finally

• finally(onfinally?: null | () => void): 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 = T, TResult2 = never>(
      onfulfilled?: null | (value: T) => TResult1 | PromiseLike<TResult1>,
      onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>,
  ): Promise<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 Promise<TResult1 | TResult2>

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

withResponse

• withResponse(): Promise<{ data: T; response: Response }>

  Returns Promise<{ data: T; response: Response }>