ApiResponseHandler | UpfrontJS

The default HandlesApiResponse implementation used by upfrontjs.

link: {HandlesApiResponse}

Hierarchy

ApiResponseHandler

Implements

HandlesApiResponse

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiResponseHandler(): ApiResponseHandler

Returns ApiResponseHandler

Methods

handle

handle<T>(promise: Promise<ApiResponse<null | string | any[] | Record<string, any>> & { request: { method: "HEAD" | "head" } }>): Promise<undefined | Omit<ApiResponse<null | string | any[] | Record<string, any>>, "data" | "json">>
handle<T>(promise: Promise<ApiResponse<T>>): Promise<undefined | T>

Implementation of HandlesApiResponse.handle
- Defined in src/Services/ApiResponseHandler.ts:13
Handle the promised response.

Type parameters
- T = unknown
Parameters
- promise: Promise<ApiResponse<null | string | any[] | Record<string, any>> & { request: { method: "HEAD" | "head" } }>
Returns Promise<undefined | Omit<ApiResponse<null | string | any[] | Record<string, any>>, "data" | "json">>
Implementation of HandlesApiResponse.handle
- Defined in src/Services/ApiResponseHandler.ts:17
Type parameters
- T
Parameters
- promise: Promise<ApiResponse<T>>
Returns Promise<undefined | T>

handleError

handleError(rejectReason: unknown): Promise<never>

- Defined in src/Services/ApiResponseHandler.ts:69
Handle errors that occurred during the promise execution.

Parameters
- rejectReason: unknown
Returns Promise<never>

handleFinally

handleFinally(): void

- Defined in src/Services/ApiResponseHandler.ts:78
If extending, you may do any final operations after the request.

Returns void

handleResponse

handleResponse(response: ApiResponse<null | string | any[] | Record<string, any>> & { request: { method: "HEAD" | "head" } }): Promise<undefined | Omit<ApiResponse<null | string | any[] | Record<string, any>>, "data" | "json">>
handleResponse<T>(response: ApiResponse<T>): Promise<undefined | T>

- Defined in src/Services/ApiResponseHandler.ts:34
Handle successful request.

throws
{ApiResponse}

Parameters
- response: ApiResponse<null | string | any[] | Record<string, any>> & { request: { method: "HEAD" | "head" } }
Returns Promise<undefined | Omit<ApiResponse<null | string | any[] | Record<string, any>>, "data" | "json">>
- Defined in src/Services/ApiResponseHandler.ts:37
Type parameters
- T
Parameters
- response: ApiResponse<T>
Returns Promise<undefined | T>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns ApiResponseHandler

Methods

handle

Type parameters

T = unknown

Parameters

promise: Promise<ApiResponse<null | string | any[] | Record<string, any>> & { request: { method: "HEAD" | "head" } }>

Returns Promise<undefined | Omit<ApiResponse<null | string | any[] | Record<string, any>>, "data" | "json">>

Type parameters

T

Parameters

promise: Promise<ApiResponse<T>>

Returns Promise<undefined | T>

handleError

Parameters

rejectReason: unknown

Returns Promise<never>

handleFinally

Returns void

handleResponse

Parameters

response: ApiResponse<null | string | any[] | Record<string, any>> & { request: { method: "HEAD" | "head" } }

Returns Promise<undefined | Omit<ApiResponse<null | string | any[] | Record<string, any>>, "data" | "json">>

Type parameters

T

Parameters

response: ApiResponse<T>

Returns Promise<undefined | T>