Class ApiResponseHandler

The default HandlesApiResponse implementation used by upfrontjs.

Link

Hierarchy

ApiResponseHandler

Implements

HandlesApiResponse

Index

Constructors

constructor

Methods

handle handleError handleFinally handleResponse

Constructors

constructor

new ApiResponseHandler(): ApiResponseHandler
Returns ApiResponseHandler

Methods

handle

handle(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 the promised response.

Returns
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:13
handle<T>(promise: Promise<ApiResponse<T>>): Promise<undefined | T>
Type Parameters
- T
Parameters
- promise: Promise<ApiResponse<T>>
Returns Promise<undefined | T>
Implementation of HandlesApiResponse.handle
- Defined in src/Services/ApiResponseHandler.ts:17

handleError

handleError(rejectReason: unknown): Promise<unknown>
Handle errors that occurred during the promise execution.

Returns
Parameters
- rejectReason: unknown
Returns Promise<unknown>
- Defined in src/Services/ApiResponseHandler.ts:68

handleFinally

handleFinally(): void
If extending, you may do any final operations after the request.

Returns

Returns void
- Defined in src/Services/ApiResponseHandler.ts:77

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">>
Handle successful request.

Returns

Throws
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:34
handleResponse<T>(response: ApiResponse<T>): Promise<undefined | T>
Type Parameters
- T
Parameters
- response: ApiResponse<T>
Returns Promise<undefined | T>
- Defined in src/Services/ApiResponseHandler.ts:37

Class ApiResponseHandler

Link

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns ApiResponseHandler

Methods

handle

Returns

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

Returns

Parameters

rejectReason: unknown

Returns Promise<unknown>

handleFinally

Returns

Returns void

handleResponse

Returns

Throws

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>

Settings

Member Visibility

Theme

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

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