Adapter

Base adapter class responsible for executing HTTP requests. Adapters handle endpoint resolution, header/payload/query-params mapping, and the actual fetch call. Extend or configure this class to integrate custom transport layers (e.g., axios, graphql, firebase).

---

Import

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

Source

View the source code

Package

@hyper-fetch/core

Parameters

class Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType> {
  constructor(options: { defaultExtra: Extra; defaultMethod: MethodType; defaultRequestOptions?: RequestOptionsType<EndpointType, AdapterOptions, MethodType>; name: string; systemErrorExtra: Extra; systemErrorStatus: StatusType }) {};
  unstable_queryParamsMapperConfig: Parameters<QueryParamsMapperType>[1];
  unstable_queryParamsMapper: QueryParamsMapperType;
  unstable_payloadMapperConfig: Parameters<PayloadMapperType>[1];
  unstable_payloadMapper: PayloadMapperType;
  unstable_headerMapperConfig: Parameters<HeaderMapperType>[1];
  unstable_headerMapper: HeaderMapperType;
  unstable_endpointMapperConfig: Parameters<EndpointMapperType>[1];
  unstable_endpointMapper: EndpointMapperType;
  systemErrorStatus: StatusType;
  systemErrorExtra: Extra;
  options: { defaultExtra: Extra; defaultMethod: MethodType; defaultRequestOptions?: RequestOptionsType<EndpointType, AdapterOptions, MethodType>; name: string; systemErrorExtra: Extra; systemErrorStatus: StatusType };
  name: string;
  logger: LoggerMethods;
  initialized: boolean;
  defaultRequestOptions: RequestOptionsType<EndpointType, AdapterOptions, MethodType>;
  defaultMethod: MethodType;
  defaultExtra: Extra;
  client: ClientInstance;
  unstable_devtoolsEndpointGetter() => (endpoint: string) => string;
  unstable_fetcher() => AdapterFetcherType<Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>>;
  unstable_getAdapterDefaults() => (request: ExtendRequest<RequestInstance, { client: Client<any, Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>> }>) => AdapterOptions;
  unstable_getRequestDefaults() => (options: RequestOptionsType<EndpointType, AdapterOptions, MethodType>) => Partial<RequestOptionsType<EndpointType, AdapterOptions, MethodType>>;
  unstable_internalErrorMapping() => (error: TimeoutError | AbortError | DeletedError | RequestProcessingError | UnexpectedError) => any;
  unstable_onInitializeCallback() => (options: { client: ClientInstance }) => void;
  fetch(request: ExtendRequest<RequestInstance, { client: Client<any, Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>> }>, requestId: string) => Promise<RequestResponseType<RequestInstance>>;
  initialize(client: ClientInstance) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  onInitialize(callback: (options: { client: ClientInstance }) => void) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setAdapterDefaults(callback: (request: ExtendRequest<RequestInstance, { client: Client<any, Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>> }>) => AdapterOptions) => this;
  setDefaultExtra(extra: Extra) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setDefaultMethod(method: MethodType) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setDevtoolsEndpointGetter(callback: (endpoint: string) => string) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setEndpointMapper<NewEndpointMapper>(endpointMapper: NewEndpointMapper) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, NewEndpointMapper, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setEndpointMapperConfig<NewEndpointMapperConfig>(config: NewEndpointMapperConfig) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setFetcher(fetcher: AdapterFetcherType<Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>>) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setHeaderMapper<NewMapper>(headerMapper: NewMapper) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, NewMapper, PayloadMapperType>;
  setHeaderMapperConfig<NewHeaderMapperConfig>(config: NewHeaderMapperConfig) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setInternalErrorMapping(callback: (error: TimeoutError | AbortError | DeletedError | RequestProcessingError | UnexpectedError) => any) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setPayloadMapper<NewMapper>(payloadMapper: NewMapper) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, NewMapper>;
  setPayloadMapperConfig<NewPayloadMapperConfig>(config: NewPayloadMapperConfig) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setQueryParamsMapper<NewQueryParamsMapper>(queryParamsMapper: NewQueryParamsMapper) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, NewQueryParamsMapper, HeaderMapperType, PayloadMapperType>;
  setQueryParamsMapperConfig<NewQueryParamsMapperConfig>(config: NewQueryParamsMapperConfig) => Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>;
  setRequestDefaults(callback: undefined | (options: RequestOptionsType<EndpointType, AdapterOptions, MethodType>) => Partial<RequestOptionsType<EndpointType, AdapterOptions, MethodType>>) => this;
}

Parameters

Name	Type	Description
options	{ defaultExtra: Extra; defaultMethod: MethodType; defaultRequestOptions?: RequestOptionsType<EndpointType, AdapterOptions, MethodType>; name: string; systemErrorExtra: Extra; systemErrorStatus: StatusType }

Properties

client

Source

View the source code

Type

ClientInstance

---

defaultExtra

Source

View the source code

Type

Extra

---

defaultMethod

Source

View the source code

Type

MethodType

---

defaultRequestOptions

Source

View the source code

Type

RequestOptionsType<EndpointType, AdapterOptions, MethodType>

---

initialized

Source

View the source code

Type

boolean

---

logger

Source

View the source code

Type

LoggerMethods

---

name

---

Defaults

---

Source

View the source code

Type

string

---

options

Source

View the source code

Type

{ defaultExtra: Extra; defaultMethod: MethodType; defaultRequestOptions?: RequestOptionsType<EndpointType, AdapterOptions, MethodType>; name: string; systemErrorExtra: Extra; systemErrorStatus: StatusType }

---

systemErrorExtra

Source

View the source code

Type

Extra

---

systemErrorStatus

Source

View the source code

Type

StatusType

---

unstable_endpointMapper

Method to get the endpoint for the adapter request.

Source

View the source code

Type

EndpointMapperType

---

unstable_endpointMapperConfig

Source

View the source code

Type

Parameters<EndpointMapperType>[1]

---

unstable_headerMapper

Method to get default headers and to map them based on the data format exchange, by default it handles FormData / JSON formats.

Source

View the source code

Type

HeaderMapperType

---

unstable_headerMapperConfig

Source

View the source code

Type

Parameters<HeaderMapperType>[1]

---

unstable_payloadMapper

Method to get request data and transform them to the required format. It handles FormData and JSON by default.

Source

View the source code

Type

PayloadMapperType

---

unstable_payloadMapperConfig

Source

View the source code

Type

Parameters<PayloadMapperType>[1]

---

unstable_queryParamsMapper

Method to get request data and transform them to the required format.

Source

View the source code

Type

QueryParamsMapperType

---

unstable_queryParamsMapperConfig

Source

View the source code

Type

Parameters<QueryParamsMapperType>[1]

---

Methods

fetch()

Execute a request through the adapter pipeline: maps endpoint/headers/payload, runs plugins, then calls the fetcher.

Source

View the source code

Preview

fetch(request: ExtendRequest<RequestInstance, { client: Client<any, Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>> }>, requestId: string)

Parameters

Parameters

Name	Type	Description
request	ExtendRequest<RequestInstance, { client: Client<any, Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>> }>
requestId	string

Returns

Promise<RequestResponseType<RequestInstance>>

---

initialize()

Initialize the adapter with a client reference and set up logging. Called automatically when the client is created.

Source

View the source code

Preview

initialize(client: ClientInstance)

Parameters

Parameters

Name	Type	Description
client	ClientInstance

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

onInitialize()

Register a callback invoked once the adapter is initialized with a client.

Source

View the source code

Preview

onInitialize(callback: (options: { client: ClientInstance }) => void)

Parameters

Parameters

Name	Type	Description
callback	(options: { client: ClientInstance }) => void

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setAdapterDefaults()

Set the adapter default options added to every sent request

Source

View the source code

Preview

setAdapterDefaults(callback: (request: ExtendRequest<RequestInstance, { client: Client<any, Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>> }>) => AdapterOptions)

Parameters

Parameters

Name	Type	Description
callback	(request: ExtendRequest<RequestInstance, { client: Client<any, Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>> }>) => AdapterOptions

Returns

this

---

setDefaultExtra()

Set the default extra metadata attached to every request response (e.g., headers, status).

Source

View the source code

Preview

setDefaultExtra(extra: Extra)

Parameters

Parameters

Name	Type	Description
extra	Extra

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setDefaultMethod()

Set the default HTTP method used when a request does not specify one.

Source

View the source code

Preview

setDefaultMethod(method: MethodType)

Parameters

Parameters

Name	Type	Description
method	MethodType

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setDevtoolsEndpointGetter()

Set a function that formats the endpoint string for display in devtools.

Source

View the source code

Preview

setDevtoolsEndpointGetter(callback: (endpoint: string) => string)

Parameters

Parameters

Name	Type	Description
callback	(endpoint: string) => string

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setEndpointMapper()

Set the endpoint mapping function which transforms the endpoint string before the request is sent

Source

View the source code

Preview

setEndpointMapper<NewEndpointMapper>(endpointMapper: NewEndpointMapper)

Parameters

Parameters

Name	Type	Description
endpointMapper	NewEndpointMapper

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, NewEndpointMapper, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setEndpointMapperConfig()

Set the configuration object passed as the second argument to the endpoint mapper.

Source

View the source code

Preview

setEndpointMapperConfig<NewEndpointMapperConfig>(config: NewEndpointMapperConfig)

Parameters

Parameters

Name	Type	Description
config	NewEndpointMapperConfig

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setFetcher()

Set the fetcher function that performs the actual network request. Must be called before any request can be executed.

Source

View the source code

Preview

setFetcher(fetcher: AdapterFetcherType<Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>>)

Parameters

Parameters

Name	Type	Description
fetcher	AdapterFetcherType<Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>>

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setHeaderMapper()

Set the custom header mapping function

Source

View the source code

Preview

setHeaderMapper<NewMapper>(headerMapper: NewMapper)

Parameters

Parameters

Name	Type	Description
headerMapper	NewMapper

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, NewMapper, PayloadMapperType>

---

setHeaderMapperConfig()

Set the configuration object passed as the second argument to the header mapper.

Source

View the source code

Preview

setHeaderMapperConfig<NewHeaderMapperConfig>(config: NewHeaderMapperConfig)

Parameters

Parameters

Name	Type	Description
config	NewHeaderMapperConfig

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setInternalErrorMapping()

Set a custom mapping for internal adapter errors before they are returned in the response.

Source

View the source code

Preview

setInternalErrorMapping(callback: (error: TimeoutError | AbortError | DeletedError | RequestProcessingError | UnexpectedError) => any)

Parameters

Parameters

Name	Type	Description
callback	(error: TimeoutError | AbortError | DeletedError | RequestProcessingError | UnexpectedError) => any

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setPayloadMapper()

Set the request payload mapping function which gets triggered before request is send

Source

View the source code

Preview

setPayloadMapper<NewMapper>(payloadMapper: NewMapper)

Parameters

Parameters

Name	Type	Description
payloadMapper	NewMapper

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, NewMapper>

---

setPayloadMapperConfig()

Set the configuration object passed as the second argument to the payload mapper.

Source

View the source code

Preview

setPayloadMapperConfig<NewPayloadMapperConfig>(config: NewPayloadMapperConfig)

Parameters

Parameters

Name	Type	Description
config	NewPayloadMapperConfig

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setQueryParamsMapper()

Set the query params mapping function which get triggered before request get sent

Source

View the source code

Preview

setQueryParamsMapper<NewQueryParamsMapper>(queryParamsMapper: NewQueryParamsMapper)

Parameters

Parameters

Name	Type	Description
queryParamsMapper	NewQueryParamsMapper

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, NewQueryParamsMapper, HeaderMapperType, PayloadMapperType>

---

setQueryParamsMapperConfig()

Set the configuration object passed as the second argument to the query params mapper.

Source

View the source code

Preview

setQueryParamsMapperConfig<NewQueryParamsMapperConfig>(config: NewQueryParamsMapperConfig)

Parameters

Parameters

Name	Type	Description
config	NewQueryParamsMapperConfig

Returns

Adapter<AdapterOptions, MethodType, StatusType, Extra, QueryParams, DefaultQueryParams, EndpointType, EndpointMapperType, QueryParamsMapperType, HeaderMapperType, PayloadMapperType>

---

setRequestDefaults()

This method allows to configure global defaults for the request configuration like method, auth, deduplication etc.

Source

View the source code

Preview

setRequestDefaults(callback: undefined | (options: RequestOptionsType<EndpointType, AdapterOptions, MethodType>) => Partial<RequestOptionsType<EndpointType, AdapterOptions, MethodType>>)

Parameters

Parameters

Name	Type	Description
callback	undefined | (options: RequestOptionsType<EndpointType, AdapterOptions, MethodType>) => Partial<RequestOptionsType<EndpointType, AdapterOptions, MethodType>>

Returns

this

---