Client
import { Client } from "@hyper-fetch/core"
Description
Client is a class that allows you to configure the connection with the server and then use it to create requests which, when called using the appropriate method, will cause the server to be queried for the endpoint and method specified in the request.
Defined in client/client.ts:35
Parameters
Name | Details |
---|---|
options
|
|
Properties
__onErrorCallbacks
__onErrorCallbacks
Description
Defined in client/client.ts:40
Type
ResponseInterceptorType<any, any>[]
__onResponseCallbacks
__onResponseCallbacks
Description
Defined in client/client.ts:42
Type
ResponseInterceptorType<any, any>[]
__onSuccessCallbacks
__onSuccessCallbacks
Description
Defined in client/client.ts:41
Type
ResponseInterceptorType<any, any>[]
Methods
adapter()
adapter()
Description
Defined in client/client.ts:52
Return
(request: RequestInstance, requestId: string) => Promise<ResponseType<any, any>>
adapterDefaultOptions()
adapterDefaultOptions()
Description
Defined in client/client.ts:62
Return
(request: RequestInstance) => AdapterOptions
headerMapper()
headerMapper()
Description
Method to get default headers and to map them based on the data format exchange, by default it handles FormData / JSON formats.
Defined in client/client.ts:77
Return
(request: T) => HeadersInit
payloadMapper()
payloadMapper()
Description
Method to get request data and transform them to the required format. It handles FormData and JSON by default.
Defined in client/client.ts:81
Return
(data: unknown) => string | FormData
requestDefaultOptions()
requestDefaultOptions()
Description
Defined in client/client.ts:63
Return
(options: RequestOptionsType<string, AdapterOptions>) => Partial<RequestOptionsType<string, AdapterOptions>>
stringifyQueryParams()
stringifyQueryParams()
Description
Method to stringify query params from objects.
Defined in client/client.ts:72
Return
(queryParams: QueryParamsType | string | NegativeTypes) => string
addEffect()
addEffect()
Preview
addEffect(effect)
Description
Add persistent effects which trigger on the request lifecycle
Defined in client/client.ts:229
Parameters
Name | Details |
---|---|
effect
|
|
Return
this
clear()
clear()
Preview
clear()
Description
Clears the Client instance and remove all listeners on it's dependencies
Defined in client/client.ts:276
Return
void
createRequest()
createRequest()
Preview
createRequest<Response, Payload, LocalError, QueryParams>()
Description
Create requests based on the Client setup
Defined in client/client.ts:298
Return
(params: RequestOptionsType<EndpointType, AdapterOptions>) => Request<Response, Payload, QueryParams, GlobalErrorType, LocalError, EndpointType, AdapterOptions, false, false, false, undefined>
onAuth()
onAuth()
Preview
onAuth(callback)
Description
Method of manipulating requests before sending the request. We can for example add custom header with token to the request which request had the auth set to true.
Defined in client/client.ts:183
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
onError()
onError()
Preview
onError<ErrorType>(callback)
Description
Method for intercepting error responses. It can be used for example to refresh tokens.
Defined in client/client.ts:191
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
onRequest()
onRequest()
Preview
onRequest(callback)
Description
Method of manipulating requests before sending the request.
Defined in client/client.ts:211
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
onResponse()
onResponse()
Preview
onResponse<ErrorType>(callback)
Description
Method for intercepting any responses.
Defined in client/client.ts:219
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
onSuccess()
onSuccess()
Preview
onSuccess<ErrorType>(callback)
Description
Method for intercepting success responses.
Defined in client/client.ts:201
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
removeEffect()
removeEffect()
Preview
removeEffect(effect)
Description
Remove effects from Client
Defined in client/client.ts:238
Parameters
Name | Details |
---|---|
effect
|
|
Return
this
setAdapter()
setAdapter()
Preview
setAdapter(callback)
Description
Set custom http adapter to handle graphql, rest, firebase or other
Defined in client/client.ts:175
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setAdapterDefaultOptions()
setAdapterDefaultOptions()
Preview
setAdapterDefaultOptions(callback)
Description
Defined in client/client.ts:108
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setDebug()
setDebug()
Preview
setDebug(debug)
Description
This method enables the logger usage and display the logs in console
Defined in client/client.ts:118
Parameters
Name | Details |
---|---|
debug
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setHeaderMapper()
setHeaderMapper()
Preview
setHeaderMapper(headerMapper)
Description
Set the custom header mapping function
Defined in client/client.ts:159
Parameters
Name | Details |
---|---|
headerMapper
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setLogger()
setLogger()
Preview
setLogger(callback)
Description
Set the new logger instance to the Client
Defined in client/client.ts:134
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setLoggerSeverity()
setLoggerSeverity()
Preview
setLoggerSeverity(severity)
Description
Set the logger severity of the messages displayed to the console
Defined in client/client.ts:126
Parameters
Name | Details |
---|---|
severity
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setPayloadMapper()
setPayloadMapper()
Preview
setPayloadMapper(payloadMapper)
Description
Set the request payload mapping function which get triggered before request get send
Defined in client/client.ts:167
Parameters
Name | Details |
---|---|
payloadMapper
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setQueryParamsConfig()
setQueryParamsConfig()
Preview
setQueryParamsConfig(queryParamsConfig)
Description
Set config for the query params stringify method, we can set here, among others, arrayFormat, skipNull, encode, skipEmptyString and more
Defined in client/client.ts:142
Parameters
Name | Details |
---|---|
queryParamsConfig
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setRequestDefaultOptions()
setRequestDefaultOptions()
Preview
setRequestDefaultOptions(callback)
Description
This method allows to configure global defaults for the request configuration like method, auth, deduplication etc.
Defined in client/client.ts:101
Parameters
Name | Details |
---|---|
callback
|
|
Return
Client<GlobalErrorType, AdapterOptions>
setStringifyQueryParams()
setStringifyQueryParams()
Preview
setStringifyQueryParams(stringifyFn)
Description
Set the custom query params stringify method to the Client
Defined in client/client.ts:151
Parameters
Name | Details |
---|---|
stringifyFn
| Custom callback handling query params stringify
|
Return
Client<GlobalErrorType, AdapterOptions>
__modifyAuth()
__modifyAuth()
Preview
__modifyAuth(request)
Description
Helper used by http adapter to apply the modifications on response error
Defined in client/client.ts:248
Parameters
Name | Details |
---|---|
request
|
|
Return
Promise<RequestInstance>
__modifyErrorResponse()
__modifyErrorResponse()
Preview
__modifyErrorResponse(response, request)
Description
Private helper to run async on-error response processing
Defined in client/client.ts:258
Parameters
Return
Promise<ResponseType<any, GlobalErrorType>>
__modifyRequest()
__modifyRequest()
Preview
__modifyRequest(request)
Description
Private helper to run async pre-request processing
Defined in client/client.ts:253
Parameters
Name | Details |
---|---|
request
|
|
Return
Promise<RequestInstance>
__modifyResponse()
__modifyResponse()
Preview
__modifyResponse(response, request)
Description
Private helper to run async response processing
Defined in client/client.ts:270
Parameters
Return
Promise<ResponseType<any, GlobalErrorType>>