Back to Node Auth0

Class HttpResponsePromise<T>

docs/classes/management.SDK.HttpResponsePromise.html

5.9.16.5 KB
Original Source

Class HttpResponsePromise<T>

A promise that returns the parsed response and lets you retrieve the raw response too.

Type Parameters

  • T

Hierarchy

  • Promise<T>
    • HttpResponsePromise

Index

Methods

fromFunctioninterceptFunctionfromPromisefromExecutorfromResultthencatchfinallywithRawResponse

Methods

StaticfromFunction

fromFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(
fn: F,
...args: Parameters<F>,
): HttpResponsePromise<T>

Creates an HttpResponsePromise from a function that returns a promise.

Type Parameters

Parameters

  • fn: F

A function that returns a promise resolving to a WithRawResponse object.

  • ...args: Parameters<F>

Arguments to pass to the function.

Returns HttpResponsePromise<T>

An HttpResponsePromise instance.

StaticinterceptFunction

interceptFunction<
F extends (...args: never[]) => Promise<WithRawResponse<T>>,
T = Awaited<ReturnType<F>>["data"],
>(
fn: F,
): (...args: Parameters<F>) => HttpResponsePromise<T>

Creates a function that returns an HttpResponsePromise from a function that returns a promise.

Type Parameters

  • F extends (...args: never[]) => Promise<WithRawResponse<T>>
  • T = Awaited<ReturnType<F>>["data"]

Parameters

  • fn: F

A function that returns a promise resolving to a WithRawResponse object.

Returns (...args: Parameters<F>) => HttpResponsePromise<T>

A function that returns an HttpResponsePromise instance.

StaticfromPromise

fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>

Creates an HttpResponsePromise from an existing promise.

Type Parameters

  • T

Parameters

A promise resolving to a WithRawResponse object.

Returns HttpResponsePromise<T>

An HttpResponsePromise instance.

StaticfromExecutor

fromExecutor<T>(
executor: (
resolve: (value: WithRawResponse<T>) => void,
reject: (reason?: unknown) => void,
) => void,
): HttpResponsePromise<T>

Creates an HttpResponsePromise from an executor function.

Type Parameters

  • T

Parameters

  • executor: (
    resolve: (value: WithRawResponse<T>) => void,
    reject: (reason?: unknown) => void,
    ) => void

A function that takes resolve and reject callbacks to create a promise.

Returns HttpResponsePromise<T>

An HttpResponsePromise instance.

StaticfromResult

fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>

Creates an HttpResponsePromise from a resolved result.

Type Parameters

  • T

Parameters

A WithRawResponse object to resolve immediately.

Returns HttpResponsePromise<T>

An HttpResponsePromise instance.

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
): Promise<TResult1 | TResult2>

Type Parameters

  • TResult1 = T
  • TResult2 = never

Parameters

Returns Promise<TResult1 | TResult2>

Inherit Doc

catch

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

Type Parameters

  • TResult = never

Parameters

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

Returns Promise<T | TResult>

Inherit Doc

finally

finally(onfinally?: (() => void) | null): Promise<T>

Parameters

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

Returns Promise<T>

Inherit Doc

withRawResponse

withRawResponse(): Promise<WithRawResponse<T>>

Retrieves the data and raw response.

Returns Promise<WithRawResponse<T>>

A promise resolving to a WithRawResponse object.

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Methods fromFunctioninterceptFunctionfromPromisefromExecutorfromResultthencatchfinallywithRawResponse