External module frest-json

Index

Interfaces

Type aliases

IJSONTransformFn

Variables

Functions

Type aliases

IJSONTransformFn

IJSONTransformFn: function

Response transformation function signature.

param: The fetch response object.
returns: string promise

Type declaration

- (response: Response): Promise<string>
- Parameters
  - response: Response
  Returns Promise<string>

Variables

Const ID_ERROR

ID_ERROR: "json:error" = "json:error"

Identifier of JSON error interceptor function.

Const ID_REQUEST

ID_REQUEST: "json:request" = "json:request"

Identifier of JSON request interceptor function.

Const ID_RESPONSE

ID_RESPONSE: "json:response" = "json:response"

Identifier of JSON response interceptor function.

Functions

errorInterceptor

errorInterceptor(opts?: IJSONErrorInterceptorOption): IErrorInterceptor

- Defined in error.ts:38
Create a JSON error interceptor.

remarks

In Frest, any kind of error, including non-OK HTTP status, during request life-cycle will be thrown. This interceptor will try to parse response body in case the request is completed but with non-OK HTTP status AND it specifies the Content-Type header is compatible with application/json or the one specified in the options.

Parameters
- Default value opts: IJSONErrorInterceptorOption = {}
  
  Options for this error interceptor.
Returns IErrorInterceptor

JSON error interceptor function

jsonInterceptors

jsonInterceptors(opts?: IJSONInterceptorsOptions): IInterceptors

- Defined in interceptors.ts:35
Create JSON interceptors set.

remarks

Specify an option for each type of interceptor to enable them. Unspecified option will make the interceptor not created.

Parameters
- Default value opts: IJSONInterceptorsOptions = {}
  
  Options for each type of JSON interceptors.
Returns IInterceptors

requestInterceptor

requestInterceptor(opts?: IJSONRequestInterceptorOption): IRequestInterceptor

- Defined in request.ts:39
Create a JSON request interceptor.

remarks

This interceptor will try to stringify the request's body configuration if it's a plain JavaScript object and set the Content-Type header to the provided IJSONRequestInterceptorOption.headerContent option. It'll also append the Accept header with the provided IJSONRequestInterceptorOption.headerAccept option.

Parameters
- Default value opts: IJSONRequestInterceptorOption = {}
  
  Options for this request interceptor
Returns IRequestInterceptor

JSON request interceptor

responseInterceptor

responseInterceptor(opts?: IJSONResponseInterceptorOption): IResponseInterceptor

- Defined in response.ts:38
Create a JSON response interceptor.

remarks

This interceptor will try to parse response's body if the response's Content-Type header is compatible with the one provided in IJSONResponseInterceptorOption.headerContent option. If IJSONResponseInterceptorOption.transform is provided, it'll call the function before parsing it.

Parameters
- Default value opts: IJSONResponseInterceptorOption = {}
  
  Options for this response interceptor
Returns IResponseInterceptor

JSON response interceptor

Generated using TypeDoc