Client

Client is a class that allows you to configure the connection with the server and then use it to create requests. It allows you to set global defaults for the requests configuration, query params configuration. It is also orchestrator for all of the HyperFetch modules like Cache, Dispatcher, AppManager, LoggerManager, RequestManager and more.

---

Import

import { Client } from "@hyper-fetch/core"

Source

View the source code

Package

@hyper-fetch/core

Parameters

class Client<GlobalErrorType, Adapter> {
  constructor(options: ClientOptionsType<Client<GlobalErrorType, Adapter>>) {};
  url: string;
  unstable_onSuccessCallbacks: ResponseInterceptorType<ClientInstance>[];
  unstable_onResponseCallbacks: ResponseInterceptorType<ClientInstance>[];
  unstable_onRequestCallbacks: RequestInterceptorType[];
  unstable_onErrorCallbacks: ResponseInterceptorType<ClientInstance>[];
  unstable_onAuthCallbacks: RequestInterceptorType[];
  submitDispatcher: Dispatcher<Adapter>;
  requestManager: RequestManager;
  plugins: PluginInstance[];
  options: ClientOptionsType<Client<GlobalErrorType, Adapter>>;
  loggerManager: LoggerManager;
  logger: LoggerMethods;
  isMockerEnabled: boolean;
  fetchDispatcher: Dispatcher<Adapter>;
  debug: boolean;
  cache: Cache<Adapter>;
  appManager: AppManager;
  adapter: Adapter;
  addPlugin(plugin: PluginInstance) => Client<GlobalErrorType, Adapter>;
  clear() => void;
  createRequest<RequestProperties>(_USE_DOUBLE_INITIALIZATION?: undefined) => <EndpointType, AdapterOptions, MethodType>(params: RequestOptionsType<EndpointType, AdapterOptions, MethodType>) => Request<TypeWithDefaults<RequestProperties, response, undefined, void>, TypeWithDefaults<RequestProperties, payload, undefined, void>, TypeWithDefaults<RequestProperties, queryParams, ExtractAdapterDefaultQueryParamsType<Adapter>, never>, TypeWithDefaults<RequestProperties, error, GlobalErrorType, void>, TypeWithDefaults<RequestProperties, endpoint, EndpointType, void> extends string ? string & TypeWithDefaults<RequestProperties, endpoint, EndpointType, void> : any, Client<GlobalErrorType, ExtractedAdapterType>, false, false, false>;
  hydrate(hydrationData: (EmptyTypes | HydrateDataType)[], options?: Partial<HydrationOptions> | (item: HydrateDataType) => Partial<HydrationOptions>) => void;
  onAuth(callback: RequestInterceptorType) => Client<GlobalErrorType, Adapter>;
  onError<ErrorType>(callback: ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>) => Client<GlobalErrorType, Adapter>;
  onRequest(callback: RequestInterceptorType) => Client<GlobalErrorType, Adapter>;
  onResponse<ErrorType>(callback: ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>) => Client<GlobalErrorType, Adapter>;
  onSuccess<ErrorType>(callback: ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>) => Client<GlobalErrorType, Adapter>;
  removeOnAuthInterceptors(callbacks: RequestInterceptorType[]) => Client<GlobalErrorType, Adapter>;
  removeOnErrorInterceptors(callbacks: ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[]) => Client<GlobalErrorType, Adapter>;
  removeOnRequestInterceptors(callbacks: RequestInterceptorType[]) => Client<GlobalErrorType, Adapter>;
  removeOnResponseInterceptors(callbacks: ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[]) => Client<GlobalErrorType, Adapter>;
  removeOnSuccessInterceptors(callbacks: ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[]) => Client<GlobalErrorType, Adapter>;
  removePlugin(plugin: PluginInstance) => Client<GlobalErrorType, Adapter>;
  setAbortKeyMapper(callback: (request: RequestInstance) => string) => Client<GlobalErrorType, Adapter>;
  setAdapter<NewAdapter>(adapter: NewAdapter) => Client<GlobalErrorType, NewAdapter>;
  setCacheKeyMapper(callback: (request: RequestInstance) => string) => Client<GlobalErrorType, Adapter>;
  setDebug(enabled: boolean) => Client<GlobalErrorType, Adapter>;
  setEnableGlobalMocking(isMockerEnabled: boolean) => Client<GlobalErrorType, Adapter>;
  setLogLevel(severity: LogLevel) => Client<GlobalErrorType, Adapter>;
  setLogger(callback: (Client: ClientInstance) => LoggerManager) => Client<GlobalErrorType, Adapter>;
  setQueryKeyMapper(callback: (request: RequestInstance) => string) => Client<GlobalErrorType, Adapter>;
  setRequestIdMapper(callback: (request: RequestInstance) => string) => Client<GlobalErrorType, Adapter>;
  triggerPlugins<Key>(key: Key, data: PluginMethodParameters<Key, Client<Error, HttpAdapterType>>) => Client<GlobalErrorType, Adapter>;
}

Parameters

Name	Type	Description
options	ClientOptionsType<Client<GlobalErrorType, Adapter>>

Properties

adapter

Source

View the source code

Type

Adapter

---

appManager

Source

View the source code

Type

AppManager

---

cache

Source

View the source code

Type

Cache<Adapter>

---

debug

Source

View the source code

Type

boolean

---

fetchDispatcher

Source

View the source code

Type

Dispatcher<Adapter>

---

isMockerEnabled

Source

View the source code

Type

boolean

---

logger

Source

View the source code

Type

LoggerMethods

---

loggerManager

Source

View the source code

Type

LoggerManager

---

options

Source

View the source code

Type

ClientOptionsType<Client<GlobalErrorType, Adapter>>

---

plugins

Source

View the source code

Type

PluginInstance[]

---

requestManager

Source

View the source code

Type

RequestManager

---

submitDispatcher

Source

View the source code

Type

Dispatcher<Adapter>

---

unstable_onAuthCallbacks

Source

View the source code

Type

RequestInterceptorType[]

---

unstable_onErrorCallbacks

Source

View the source code

Type

ResponseInterceptorType<ClientInstance>[]

---

unstable_onRequestCallbacks

Source

View the source code

Type

RequestInterceptorType[]

---

unstable_onResponseCallbacks

Source

View the source code

Type

ResponseInterceptorType<ClientInstance>[]

---

unstable_onSuccessCallbacks

Source

View the source code

Type

ResponseInterceptorType<ClientInstance>[]

---

url

Source

View the source code

Type

string

---

Methods

addPlugin()

Add persistent plugins which trigger on the request lifecycle

Source

View the source code

Preview

addPlugin(plugin: PluginInstance)

Parameters

Parameters

Name	Type	Description
plugin	PluginInstance

Returns

Client<GlobalErrorType, Adapter>

---

clear()

Clears the Client instance and remove all listeners on it's dependencies

Source

View the source code

Preview

clear()

Returns

void

---

createRequest()

Create requests based on the Client setup

Source

View the source code

Preview

createRequest<RequestProperties>(_USE_DOUBLE_INITIALIZATION: undefined)

Parameters

Parameters

Name	Type	Description
_USE_DOUBLE_INITIALIZATION	undefined	createRequest must be initialized twice(currying). ✅ Good: const request = createRequest<RequestProperties>()(params) ⛔ Bad: const request = createRequest<RequestProperties>(params) We are using currying to achieve auto generated types for the endpoint string. This solution will be removed once https://github.com/microsoft/TypeScript/issues/10571 get resolved.

Returns

<EndpointType, AdapterOptions, MethodType>(params: RequestOptionsType<EndpointType, AdapterOptions, MethodType>) => Request<TypeWithDefaults<RequestProperties, response, undefined, void>, TypeWithDefaults<RequestProperties, payload, undefined, void>, TypeWithDefaults<RequestProperties, queryParams, ExtractAdapterDefaultQueryParamsType<Adapter>, never>, TypeWithDefaults<RequestProperties, error, GlobalErrorType, void>, TypeWithDefaults<RequestProperties, endpoint, EndpointType, void> extends string ? string & TypeWithDefaults<RequestProperties, endpoint, EndpointType, void> : any, Client<GlobalErrorType, ExtractedAdapterType>, false, false, false>

---

hydrate()

Hydrate your SSR cache data

Source

View the source code

Preview

hydrate(hydrationData: (EmptyTypes | HydrateDataType)[], options: Partial<HydrationOptions> | (item: HydrateDataType) => Partial<HydrationOptions>)

Parameters

Parameters

Name	Type	Description
hydrationData	(EmptyTypes | HydrateDataType)[]
options	Partial<HydrationOptions> | (item: HydrateDataType) => Partial<HydrationOptions>

Returns

void

---

onAuth()

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.

Source

View the source code

Preview

onAuth(callback: RequestInterceptorType)

Parameters

Parameters

Name	Type	Description
callback	RequestInterceptorType

Returns

Client<GlobalErrorType, Adapter>

---

onError()

Method for intercepting error responses. It can be used for example to refresh tokens.

Source

View the source code

Preview

onError<ErrorType>(callback: ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>)

Parameters

Parameters

Name	Type	Description
callback	ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>

Returns

Client<GlobalErrorType, Adapter>

---

onRequest()

Method of manipulating requests before sending the request.

Source

View the source code

Preview

onRequest(callback: RequestInterceptorType)

Parameters

Parameters

Name	Type	Description
callback	RequestInterceptorType

Returns

Client<GlobalErrorType, Adapter>

---

onResponse()

Method for intercepting any responses.

Source

View the source code

Preview

onResponse<ErrorType>(callback: ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>)

Parameters

Parameters

Name	Type	Description
callback	ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>

Returns

Client<GlobalErrorType, Adapter>

---

onSuccess()

Method for intercepting success responses.

Source

View the source code

Preview

onSuccess<ErrorType>(callback: ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>)

Parameters

Parameters

Name	Type	Description
callback	ResponseInterceptorType<ClientInstance, any, GlobalErrorType | ErrorType>

Returns

Client<GlobalErrorType, Adapter>

---

removeOnAuthInterceptors()

Method for removing listeners on auth.

Source

View the source code

Preview

removeOnAuthInterceptors(callbacks: RequestInterceptorType[])

Parameters

Parameters

Name	Type	Description
callbacks	RequestInterceptorType[]

Returns

Client<GlobalErrorType, Adapter>

---

removeOnErrorInterceptors()

Method for removing listeners on error.

Source

View the source code

Preview

removeOnErrorInterceptors(callbacks: ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[])

Parameters

Parameters

Name	Type	Description
callbacks	ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[]

Returns

Client<GlobalErrorType, Adapter>

---

removeOnRequestInterceptors()

Method for removing listeners on request.

Source

View the source code

Preview

removeOnRequestInterceptors(callbacks: RequestInterceptorType[])

Parameters

Parameters

Name	Type	Description
callbacks	RequestInterceptorType[]

Returns

Client<GlobalErrorType, Adapter>

---

removeOnResponseInterceptors()

Method for removing listeners on request.

Source

View the source code

Preview

removeOnResponseInterceptors(callbacks: ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[])

Parameters

Parameters

Name	Type	Description
callbacks	ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[]

Returns

Client<GlobalErrorType, Adapter>

---

removeOnSuccessInterceptors()

Method for removing listeners on success.

Source

View the source code

Preview

removeOnSuccessInterceptors(callbacks: ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[])

Parameters

Parameters

Name	Type	Description
callbacks	ResponseInterceptorType<ClientInstance, any, (null | GlobalErrorType)>[]

Returns

Client<GlobalErrorType, Adapter>

---

removePlugin()

Remove plugins from Client

Source

View the source code

Preview

removePlugin(plugin: PluginInstance)

Parameters

Parameters

Name	Type	Description
plugin	PluginInstance

Returns

Client<GlobalErrorType, Adapter>

---

setAbortKeyMapper()

Key setters

Source

View the source code

Preview

setAbortKeyMapper(callback: (request: RequestInstance) => string)

Parameters

Parameters

Name	Type	Description
callback	(request: RequestInstance) => string

Returns

Client<GlobalErrorType, Adapter>

---

setAdapter()

Set custom http adapter to handle graphql, rest, firebase or others

Source

View the source code

Preview

setAdapter<NewAdapter>(adapter: NewAdapter)

Parameters

Parameters

Name	Type	Description
adapter	NewAdapter

Returns

Client<GlobalErrorType, NewAdapter>

---

setCacheKeyMapper()

Source

View the source code

Preview

setCacheKeyMapper(callback: (request: RequestInstance) => string)

Parameters

Parameters

Name	Type	Description
callback	(request: RequestInstance) => string

Returns

Client<GlobalErrorType, Adapter>

---

setDebug()

This method enables the logger usage and display the logs in console

Source

View the source code

Preview

setDebug(enabled: boolean)

Parameters

Parameters

Name	Type	Description
enabled	boolean

Returns

Client<GlobalErrorType, Adapter>

---

setEnableGlobalMocking()

Set globally if mocking should be enabled or disabled for all client requests.

Source

View the source code

Preview

setEnableGlobalMocking(isMockerEnabled: boolean)

Parameters

Parameters

Name	Type	Description
isMockerEnabled	boolean

Returns

Client<GlobalErrorType, Adapter>

---

setLogLevel()

Set the logger severity of the messages displayed to the console

Source

View the source code

Preview

setLogLevel(severity: LogLevel)

Parameters

Parameters

Name	Type	Description
severity	LogLevel

Returns

Client<GlobalErrorType, Adapter>

---

setLogger()

Set the new logger instance to the Client

Source

View the source code

Preview

setLogger(callback: (Client: ClientInstance) => LoggerManager)

Parameters

Parameters

Name	Type	Description
callback	(Client: ClientInstance) => LoggerManager

Returns

Client<GlobalErrorType, Adapter>

---

setQueryKeyMapper()

Source

View the source code

Preview

setQueryKeyMapper(callback: (request: RequestInstance) => string)

Parameters

Parameters

Name	Type	Description
callback	(request: RequestInstance) => string

Returns

Client<GlobalErrorType, Adapter>

---

setRequestIdMapper()

Source

View the source code

Preview

setRequestIdMapper(callback: (request: RequestInstance) => string)

Parameters

Parameters

Name	Type	Description
callback	(request: RequestInstance) => string

Returns

Client<GlobalErrorType, Adapter>

---

triggerPlugins()

Source

View the source code

Preview

triggerPlugins<Key>(key: Key, data: PluginMethodParameters<Key, Client<Error, HttpAdapterType>>)

Parameters

Parameters

Name	Type	Description
key	Key
data	PluginMethodParameters<Key, Client<Error, HttpAdapterType>>

Returns

Client<GlobalErrorType, Adapter>

---