Request

Request is a class that represents a request sent to the server. It contains all the necessary information to make a request, like endpoint, method, headers, data, and much more. It is executed at any time via methods like send or exec .

We can set it up with options like endpoint, method, headers and more. We can choose some of advanced settings like cache, invalidation patterns, concurrency, retries and much, much more.

---

Import

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

Source

View the source code

Package

@hyper-fetch/core

Parameters

class Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext> {
  constructor(client: Client, requestOptions: ClientRequestOptions<Endpoint, Client>, initialRequestConfiguration: RequestConfigurationType<Payload, Endpoint extends string ? ExtractUrlParams<Endpoint<Endpoint>> : never, QueryParams, Endpoint, ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>, ExtractAdapterMethodType<ExtractClientAdapterType<Client>>>) {};
  used: boolean;
  unstable_mock: { config: MockerConfigType; fn: (options: { request: RequestInstance; requestId: string }) => MockResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>> };
  unstable_hasQuery: HasQuery;
  unstable_hasPayload: HasPayload;
  unstable_hasParams: HasParams;
  unstable_hasMutationContext: MutationContext;
  staleTime: number;
  scope: null | string;
  retryTime: number;
  retry: number;
  requestOptions: ClientRequestOptions<Endpoint, Client>;
  queued: boolean;
  queryParams: EmptyTypes | QueryParams;
  queryKey: string;
  payload: PayloadType<Payload>;
  params: EmptyTypes | ExtractUrlParams<Endpoint>;
  options: ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>;
  offline: boolean;
  method: ExtractAdapterMethodType<ExtractClientAdapterType<Client>>;
  isMockerEnabled: boolean;
  initialRequestConfiguration: RequestConfigurationType<Payload, Endpoint extends string ? ExtractUrlParams<Endpoint<Endpoint>> : never, QueryParams, Endpoint, ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>, ExtractAdapterMethodType<ExtractClientAdapterType<Client>>>;
  headers: HeadersInit;
  endpoint: Endpoint;
  deduplicateTime: null | number;
  deduplicate: boolean;
  client: Client;
  cancelable: boolean;
  cacheTime: number;
  cacheKey: string;
  cache: boolean;
  auth: boolean;
  abortKey: string;
  $hooks: RequestHooks<RequestInstance>;
  exec() => RequestSendType<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>>;
  send() => RequestSendType<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>>;
  abort() => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  clearMock() => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  clone<NewData, NewParams, NewQueryParams>(configuration?: RequestConfigurationType<Payload, EmptyTypes | ExtractUrlParams<Endpoint>, QueryParams, Endpoint, ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>, ExtractAdapterMethodType<ExtractClientAdapterType<Client>>>) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, NewData, NewParams, NewQueryParams, MutationContext>;
  dehydrate(config?: { override?: boolean; response?: ResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>> }) => undefined | HydrateDataType<Response, (LocalError | ExtractClientGlobalError<Client>), ExtractClientAdapterType<Client>>;
  read() => undefined | ResponseType<Response, (LocalError | ExtractClientGlobalError<Client>), ExtractClientAdapterType<Client>>;
  setAbortKey(abortKey: string) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setAuth(auth: boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setCache(cache: undefined | boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setCacheKey(cacheKey: string) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setCacheTime(cacheTime: undefined | number) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setCancelable(cancelable: boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setDeduplicate(deduplicate: boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setDeduplicateTime(deduplicateTime: number) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setHeaders(headers: HeadersInit) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setMock(fn: (options: { request: Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, undefined>; requestId: string }) => SyncOrAsync<MockResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>>>, config: MockerConfigType) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setMockingEnabled(isMockerEnabled: boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setOffline(offline: boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setOptimistic<Ctx>(callback: OptimisticCallback<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, Ctx>) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, Ctx>;
  setOptions(options: ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, true, MutationContext>;
  setParams<P>(params: P) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, P extends null ? false : true, HasQuery, MutationContext>;
  setPayload<P>(payload: P) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, P extends null ? false : true, HasParams, HasQuery, MutationContext>;
  setPayloadMapper<MappedPayload>(payloadMapper: (data: Payload) => MappedPayload) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setQueryKey(queryKey: string) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setQueryParams(queryParams: QueryParams) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, true, MutationContext>;
  setQueued(queued: boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setRequestMapper<NewRequest>(requestMapper: RequestMapper<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, NewRequest>) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setResponseMapper<MappedResponse>(responseMapper?: ResponseMapper<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, MappedResponse>) => Request<MappedResponse extends ResponseType<R, any, any> ? R : Response, Payload, QueryParams, MappedResponse extends ResponseType<any, E, any> ? E : LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setRetry(retry: undefined | number) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setRetryOnError(callback: RetryOnErrorCallbackType<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, undefined>>) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setRetryTime(retryTime: undefined | number) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setScope(scopeId: string) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setStaleTime(staleTime: undefined | number) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  setUsed(used: boolean) => Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>;
  toJSON() => RequestJSON<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>>;
  fromJSON<NewResponse, NewPayload, NewQueryParams, NewLocalError, NewEndpoint, NewClient, NewHasPayload, NewHasParams, NewHasQuery>(client: NewClient, json: RequestJSON<Request<NewResponse, NewPayload, NewQueryParams, NewLocalError, NewEndpoint, NewClient, NewHasPayload, NewHasParams, NewHasQuery, undefined>>) => Request<NewResponse, NewPayload, NewQueryParams, NewLocalError, NewEndpoint, NewClient, NewHasPayload, NewHasParams, NewHasQuery, undefined>;
}

Parameters

Name	Type	Description
client	Client
requestOptions	ClientRequestOptions<Endpoint, Client>
initialRequestConfiguration	RequestConfigurationType<Payload, Endpoint extends string ? ExtractUrlParams<Endpoint<Endpoint>> : never, QueryParams, Endpoint, ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>, ExtractAdapterMethodType<ExtractClientAdapterType<Client>>>

Properties

$hooks

Instance-level lifecycle hooks. These callbacks fire for every send() / exec() call made on this request instance (and its clones), without needing to pass them to send() each time. Useful for cross-cutting concerns like logging, analytics, or toast notifications.

Each method registers a callback and returns an unsubscribe function. Multiple listeners per hook are supported.

Source

View the source code

Type

RequestHooks<RequestInstance>

---

abortKey

Source

View the source code

Type

string

---

auth

Source

View the source code

Type

boolean

---

cache

Source

View the source code

Type

boolean

---

cacheKey

Source

View the source code

Type

string

---

cacheTime

Source

View the source code

Type

number

---

cancelable

Source

View the source code

Type

boolean

---

client

Source

View the source code

Type

Client

---

deduplicate

Source

View the source code

Type

boolean

---

deduplicateTime

Source

View the source code

Type

null | number

---

endpoint

Source

View the source code

Type

Endpoint

---

headers

Source

View the source code

Type

HeadersInit

---

initialRequestConfiguration

Source

View the source code

Type

RequestConfigurationType<Payload, Endpoint extends string ? ExtractUrlParams<Endpoint<Endpoint>> : never, QueryParams, Endpoint, ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>, ExtractAdapterMethodType<ExtractClientAdapterType<Client>>>

---

isMockerEnabled

Source

View the source code

Type

boolean

---

method

Source

View the source code

Type

ExtractAdapterMethodType<ExtractClientAdapterType<Client>>

---

offline

Source

View the source code

Type

boolean

---

options

Source

View the source code

Type

ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>

---

params

Source

View the source code

Type

EmptyTypes | ExtractUrlParams<Endpoint>

---

payload

Source

View the source code

Type

PayloadType<Payload>

---

queryKey

Source

View the source code

Type

string

---

queryParams

Source

View the source code

Type

EmptyTypes | QueryParams

---

queued

Source

View the source code

Type

boolean

---

requestOptions

Source

View the source code

Type

ClientRequestOptions<Endpoint, Client>

---

retry

Source

View the source code

Type

number

---

retryTime

Source

View the source code

Type

number

---

scope

Source

View the source code

Type

null | string

---

staleTime

Source

View the source code

Type

number

---

unstable_hasMutationContext

Source

View the source code

Type

MutationContext

---

unstable_hasParams

Source

View the source code

Type

HasParams

---

unstable_hasPayload

Source

View the source code

Type

HasPayload

---

unstable_hasQuery

Source

View the source code

Type

HasQuery

---

unstable_mock

Source

View the source code

Type

{ config: MockerConfigType; fn: (options: { request: RequestInstance; requestId: string }) => MockResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>> }

---

used

Source

View the source code

Type

boolean

---

Methods

abort()

Abort all in-flight requests sharing this request's abort key.

Source

View the source code

Preview

abort()

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

clearMock()

Remove any attached mock handler and disable mocking for this request.

Source

View the source code

Preview

clearMock()

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

clone()

Create a new request instance with optional configuration overrides. Used internally by all setter methods.

Source

View the source code

Preview

clone<NewData, NewParams, NewQueryParams>(configuration: RequestConfigurationType<Payload, EmptyTypes | ExtractUrlParams<Endpoint>, QueryParams, Endpoint, ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>, ExtractAdapterMethodType<ExtractClientAdapterType<Client>>>)

Parameters

Parameters

Name	Type	Description
configuration	RequestConfigurationType<Payload, EmptyTypes | ExtractUrlParams<Endpoint>, QueryParams, Endpoint, ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>, ExtractAdapterMethodType<ExtractClientAdapterType<Client>>>

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, NewData, NewParams, NewQueryParams, MutationContext>

---

dehydrate()

Extract the current cache data for this request into a portable hydration payload (useful for SSR).

Source

View the source code

Preview

dehydrate(config: { override?: boolean; response?: ResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>> })

Parameters

Parameters

Name	Type	Description
config	{ override?: boolean; response?: ResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>> }

Returns

undefined | HydrateDataType<Response, (LocalError | ExtractClientGlobalError<Client>), ExtractClientAdapterType<Client>>

---

read()

Read the response from cache data

If it returns error and data at the same time, it means that latest request was failed and we show previous data from cache together with error received from actual request

Source

View the source code

Preview

read()

Returns

undefined | ResponseType<Response, (LocalError | ExtractClientGlobalError<Client>), ExtractClientAdapterType<Client>>

---

setAbortKey()

Override the abort key used to cancel this request.

Source

View the source code

Preview

setAbortKey(abortKey: string)

Parameters

Parameters

Name	Type	Description
abortKey	string

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setAuth()

Set whether authentication interceptors should run for this request.

Source

View the source code

Preview

setAuth(auth: boolean)

Parameters

Parameters

Name	Type	Description
auth	boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setCache()

Set whether this request should use the cache.

Source

View the source code

Preview

setCache(cache: undefined | boolean)

Parameters

Parameters

Name	Type	Description
cache	undefined | boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setCacheKey()

Override the cache key used to store/retrieve the response.

Source

View the source code

Preview

setCacheKey(cacheKey: string)

Parameters

Parameters

Name	Type	Description
cacheKey	string

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setCacheTime()

Set how long (in ms) the response remains in cache before being garbage collected.

Source

View the source code

Preview

setCacheTime(cacheTime: undefined | number)

Parameters

Parameters

Name	Type	Description
cacheTime	undefined | number

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setCancelable()

Set whether in-flight requests with the same abort key are cancelled when a new one is dispatched.

Source

View the source code

Preview

setCancelable(cancelable: boolean)

Parameters

Parameters

Name	Type	Description
cancelable	boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setDeduplicate()

Enable or disable request deduplication. When enabled, concurrent identical requests share a single response.

Source

View the source code

Preview

setDeduplicate(deduplicate: boolean)

Parameters

Parameters

Name	Type	Description
deduplicate	boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setDeduplicateTime()

Set the time window (in ms) during which identical requests are deduplicated.

Source

View the source code

Preview

setDeduplicateTime(deduplicateTime: number)

Parameters

Parameters

Name	Type	Description
deduplicateTime	number

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setHeaders()

Set the request headers. Returns a cloned request with the new headers applied.

Source

View the source code

Preview

setHeaders(headers: HeadersInit)

Parameters

Parameters

Name	Type	Description
headers	HeadersInit

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setMock()

Attach a mock handler to this request. When mocking is enabled, the handler is called instead of the real adapter.

Source

View the source code

Preview

setMock(fn: (options: { request: Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, undefined>; requestId: string }) => SyncOrAsync<MockResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>>>, config: MockerConfigType)

Parameters

Parameters

Name	Type	Description
fn	(options: { request: Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, undefined>; requestId: string }) => SyncOrAsync<MockResponseType<Response, LocalError | ExtractClientGlobalError<Client>, ExtractClientAdapterType<Client>>>
config	MockerConfigType

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setMockingEnabled()

Enable or disable the mocker for this request without removing the mock handler.

Source

View the source code

Preview

setMockingEnabled(isMockerEnabled: boolean)

Parameters

Parameters

Name	Type	Description
isMockerEnabled	boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setOffline()

Set whether the request should be stored in the offline queue when there is no network connection.

Source

View the source code

Preview

setOffline(offline: boolean)

Parameters

Parameters

Name	Type	Description
offline	boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setOptimistic()

Configure optimistic update behavior for this request. The callback runs before the request is sent (in React's useSubmit ) and receives the request, client, and payload. Return context (available in submit callbacks),

rollback (called automatically on failure/abort), and invalidate (cache keys invalidated on success).

Source

View the source code

Preview

setOptimistic<Ctx>(callback: OptimisticCallback<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, Ctx>)

Parameters

Parameters

Name	Type	Description
callback	OptimisticCallback<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, Ctx>

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, Ctx>

---

setOptions()

Set adapter-specific options (e.g., axios config, fetch init).

Source

View the source code

Preview

setOptions(options: ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>)

Parameters

Parameters

Name	Type	Description
options	ExtractAdapterOptionsType<ExtractClientAdapterType<Client>>

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, true, MutationContext>

---

setParams()

Set the URL path parameters (e.g., :userId ).

Source

View the source code

Preview

setParams<P>(params: P)

Parameters

Parameters

Name	Type	Description
params	P

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, P extends null ? false : true, HasQuery, MutationContext>

---

setPayload()

Set the request body payload.

Source

View the source code

Preview

setPayload<P>(payload: P)

Parameters

Parameters

Name	Type	Description
payload	P

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, P extends null ? false : true, HasParams, HasQuery, MutationContext>

---

setPayloadMapper()

Map data before it gets send to the server

Source

View the source code

Preview

setPayloadMapper<MappedPayload>(payloadMapper: (data: Payload) => MappedPayload)

Parameters

Parameters

Name	Type	Description
payloadMapper	(data: Payload) => MappedPayload

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setQueryKey()

Override the query key that identifies this request in the dispatcher queue.

Source

View the source code

Preview

setQueryKey(queryKey: string)

Parameters

Parameters

Name	Type	Description
queryKey	string

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setQueryParams()

Set the query parameters appended to the URL.

Source

View the source code

Preview

setQueryParams(queryParams: QueryParams)

Parameters

Parameters

Name	Type	Description
queryParams	QueryParams

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, true, MutationContext>

---

setQueued()

Set whether the request should be queued and executed sequentially rather than immediately.

Source

View the source code

Preview

setQueued(queued: boolean)

Parameters

Parameters

Name	Type	Description
queued	boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setRequestMapper()

Map request before it gets send to the server

Source

View the source code

Preview

setRequestMapper<NewRequest>(requestMapper: RequestMapper<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, NewRequest>)

Parameters

Parameters

Name	Type	Description
requestMapper	RequestMapper<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, NewRequest>	mapper of the request

Returns

new request

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setResponseMapper()

Map the response to the new interface

Source

View the source code

Preview

setResponseMapper<MappedResponse>(responseMapper: ResponseMapper<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, MappedResponse>)

Parameters

Parameters

Name	Type	Description
responseMapper	ResponseMapper<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>, MappedResponse>	our mapping callback

Returns

new response

Request<MappedResponse extends ResponseType<R, any, any> ? R : Response, Payload, QueryParams, MappedResponse extends ResponseType<any, E, any> ? E : LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setRetry()

Set the number of retry attempts on failure.

Source

View the source code

Preview

setRetry(retry: undefined | number)

Parameters

Parameters

Name	Type	Description
retry	undefined | number

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setRetryOnError()

Set a callback that controls whether a failed request should be retried. Called on each failed attempt before scheduling the next retry. Return true to allow the retry, false to stop retrying immediately.

Source

View the source code

Preview

setRetryOnError(callback: RetryOnErrorCallbackType<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, undefined>>)

Parameters

Parameters

Name	Type	Description
callback	RetryOnErrorCallbackType<Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, undefined>>

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setRetryTime()

Set the delay in milliseconds between retry attempts.

Source

View the source code

Preview

setRetryTime(retryTime: undefined | number)

Parameters

Parameters

Name	Type	Description
retryTime	undefined | number

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setScope()

Set a scope identifier for this request. All keys (cache, queue, abort) are prefixed with this scope, isolating the request from other scopes. In "server" client mode, setting a scope also enables caching (which is otherwise disabled to prevent cross-request leaks).

Source

View the source code

Preview

setScope(scopeId: string)

Parameters

Parameters

Name	Type	Description
scopeId	string

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setStaleTime()

Set how long (in ms) cached data is considered fresh before triggering a revalidation.

Source

View the source code

Preview

setStaleTime(staleTime: undefined | number)

Parameters

Parameters

Name	Type	Description
staleTime	undefined | number

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

setUsed()

Mark the request as used (prevents automatic refetching in hooks).

Source

View the source code

Preview

setUsed(used: boolean)

Parameters

Parameters

Name	Type	Description
used	boolean

Returns

Request<Response, Payload, QueryParams, LocalError, Endpoint, Client, HasPayload, HasParams, HasQuery, MutationContext>

---

toJSON()

Serialize the request configuration into a plain JSON object for persistence or transfer.

Source

View the source code

Preview

toJSON()

Returns

toJSON

Name	Type	Description
abortKey	string
auth	boolean
cache	boolean
cacheKey	string
cacheTime	number
cancelable	boolean
deduplicate	boolean
deduplicateTime	number | null
disableRequestInterceptors	boolean | undefined
disableResponseInterceptors	boolean | undefined
endpoint	ExtractEndpointType<Request>
hasMock	boolean
headers	HeadersInit
isMockerEnabled	boolean
method	ExtractAdapterMethodType<ExtractAdapterType<Request>>
offline	boolean
options	ExtractAdapterOptionsType<ExtractAdapterType<Request>>
params	ExtractParamsType<Request> | EmptyTypes
payload	PayloadType<ExtractPayloadType<Request>>
queryKey	string
queryParams	ExtractQueryParamsType<Request> | EmptyTypes
queued	boolean
requestOptions	RequestOptionsType<ExtractEndpointType<Request>, ExtractAdapterOptionsType<ExtractAdapterType<Request>>, ExtractAdapterMethodType<ExtractAdapterType<Request>>>
retry	number
retryTime	number
scope	string | null
staleTime	number
updatedAbortKey	boolean
updatedCacheKey	boolean
updatedQueryKey	boolean
used	boolean

---

fromJSON()

Reconstruct a Request instance from a previously serialized JSON representation.

Source

View the source code

Preview

fromJSON<NewResponse, NewPayload, NewQueryParams, NewLocalError, NewEndpoint, NewClient, NewHasPayload, NewHasParams, NewHasQuery>(client: NewClient, json: RequestJSON<Request<NewResponse, NewPayload, NewQueryParams, NewLocalError, NewEndpoint, NewClient, NewHasPayload, NewHasParams, NewHasQuery, undefined>>)

Parameters

Parameters

Name	Type	Description
client	NewClient
json	RequestJSON<Request<NewResponse, NewPayload, NewQueryParams, NewLocalError, NewEndpoint, NewClient, NewHasPayload, NewHasParams, NewHasQuery, undefined>>

Returns

Request<NewResponse, NewPayload, NewQueryParams, NewLocalError, NewEndpoint, NewClient, NewHasPayload, NewHasParams, NewHasQuery, undefined>

---