Request

---

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

Description

Fetch request it is designed to prepare the necessary setup to execute the request to the server. We can setup basic options for example endpoint, method, headers and advanced settings like cache, invalidation patterns, concurrency, retries and much, much more.

Usage

We should not use this class directly in the standard development flow. We can initialize it using the createRequest method on the Client class.

Defined in request/request.ts:33

Parameters

Name	Details
client Required	Client<GlobalError, AdapterOptions>
requestOptions Required	RequestOptionsType<Endpoint, AdapterOptions>
requestDump Optional	RequestCurrentType<Response, Payload, QueryParams, GlobalError | LocalError, Endpoint, AdapterOptions, MappedData>
dataMapper Optional	PayloadMapperType<Payload, MappedData>

Properties

abortKey

Description

Defined in request/request.ts:62

Type

string

---

auth

Description

Defined in request/request.ts:48

Type

boolean

---

cache

Description

Defined in request/request.ts:58

Type

boolean

---

cacheKey

Description

Defined in request/request.ts:63

Type

string

---

cacheTime

Description

Defined in request/request.ts:59

Type

number

---

cancelable

Description

Defined in request/request.ts:54

Type

boolean

---

client

Description

Defined in request/request.ts:76

Type

Client<GlobalError, AdapterOptions>

---

data

Description

Defined in request/request.ts:51

Type

MappedData extends never ? Payload : MappedData

---

deduplicate

Description

Defined in request/request.ts:67

Type

boolean

---

deduplicateTime

Description

Defined in request/request.ts:68

Type

number

---

effectKey

Description

Defined in request/request.ts:65

Type

string

---

endpoint

Description

Defined in request/request.ts:46

Type

Endpoint

---

garbageCollection

Description

Defined in request/request.ts:57

Type

number

---

headers

Description

Defined in request/request.ts:47

Type

HeadersInit

---

method

Description

Defined in request/request.ts:49

Type

HttpMethodsType

---

offline

Description

Defined in request/request.ts:61

Type

boolean

---

options

Description

Defined in request/request.ts:53

Type

AdapterOptions

---

params

Description

Defined in request/request.ts:50

Type

ExtractRouteParams<Endpoint>

---

queryParams

Description

Defined in request/request.ts:52

Type

QueryParams

---

queueKey

Description

Defined in request/request.ts:64

Type

string

---

queued

Description

Defined in request/request.ts:60

Type

boolean

---

requestDump

Description

Defined in request/request.ts:78

Type

RequestCurrentType<Response, Payload, QueryParams, GlobalError | LocalError, Endpoint, AdapterOptions, MappedData>

---

requestOptions

Description

Defined in request/request.ts:77

Type

RequestOptionsType<Endpoint, AdapterOptions>

---

retry

Description

Defined in request/request.ts:55

Type

number

---

retryTime

Description

Defined in request/request.ts:56

Type

number

---

used

Description

Defined in request/request.ts:66

Type

boolean

---

Methods

dataMapper()

Description

Defined in request/request.ts:89

Return

(data: PayloadType) => MappedData

---

exec()

Description

Method to use the request WITHOUT adding it to cache and queues. This mean it will make simple request without queue side effects.

Defined in request/request.ts:389

Return

Promise<[Data | null, Error | null, HttpStatus]>

---

send()

Description

Method used to perform requests with usage of cache and queues

Defined in request/request.ts:446

Return

Promise<[Data | null, Error | null, HttpStatus]>

---

abort()

Preview

abort()

Description

Defined in request/request.ts:373

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

clone()

Preview

clone<D, P, Q, NewMappedData>(options, mapper)

Description

Defined in request/request.ts:304

Parameters

Name	Details
options Optional	RequestCurrentType<Response, Payload, QueryParams, GlobalError | LocalError, Endpoint, AdapterOptions, NewMappedData>
mapper Optional	PayloadMapperType<Payload, NewMappedData>

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, D, P, Q, NewMappedData>

---

dump()

Preview

dump()

Description

Defined in request/request.ts:253

Return

{
  abortKey: string;
  auth: boolean;
  cache: boolean;
  cacheKey: string;
  cacheTime: number;
  cancelable: boolean;
  data: MappedData extends never ? Payload : MappedData | \null\ | \undefined\;
  deduplicate: boolean;
  deduplicateTime: number;
  disableRequestInterceptors: boolean | undefined;
  disableResponseInterceptors: boolean | undefined;
  effectKey: string;
  endpoint: string;
  garbageCollection: number;
  headers: HeadersInit;
  method: GET | POST | PUT | PATCH | DELETE;
  offline: boolean;
  options: AdapterOptions | T extends Request<any, any, any, any, any, any, infer O, any, any, any, any> ? O : never;
  params: Params | \null\ | \undefined\;
  queryParams: QueryParams | \null\ | \undefined\;
  queueKey: string;
  queued: boolean;
  requestOptions: {
    abortKey: string;
    auth: boolean;
    cache: boolean;
    cacheKey: string;
    cacheTime: number;
    cancelable: boolean;
    deduplicate: boolean;
    deduplicateTime: number;
    disableRequestInterceptors: boolean;
    disableResponseInterceptors: boolean;
    effectKey: string;
    endpoint: GenericEndpoint;
    garbageCollection: number;
    headers: HeadersInit;
    method: GET | POST | PUT | PATCH | DELETE;
    offline: boolean;
    options: AdapterOptions;
    queueKey: string;
    queued: boolean;
    retry: number;
    retryTime: number;
  };
  retry: number;
  retryTime: number;
  updatedAbortKey: boolean;
  updatedCacheKey: boolean;
  updatedEffectKey: boolean;
  updatedQueueKey: boolean;
  used: boolean;
}

---

setAbortKey()

Preview

setAbortKey(abortKey)

Description

Defined in request/request.ts:200

Parameters

Name	Details
abortKey Required	string

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setAuth()

Preview

setAuth(auth)

Description

Defined in request/request.ts:147

Parameters

Name	Details
auth Required	boolean

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setCache()

Preview

setCache(cache)

Description

Defined in request/request.ts:188

Parameters

Name	Details
cache Required	boolean

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setCacheKey()

Preview

setCacheKey(cacheKey)

Description

Defined in request/request.ts:205

Parameters

Name	Details
cacheKey Required	string

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setCacheTime()

Preview

setCacheTime(cacheTime)

Description

Defined in request/request.ts:192

Parameters

Name	Details
cacheTime Required	number

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setCancelable()

Preview

setCancelable(cancelable)

Description

Defined in request/request.ts:170

Parameters

Name	Details
cancelable Required	boolean

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setData()

Preview

setData<D>(data)

Description

Defined in request/request.ts:155

Parameters

Name	Details
data Required	D

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, D extends null ? false : true, HasParams, HasQuery, MappedData>

---

setDataMapper()

Preview

setDataMapper<DataMapper>(mapper)

Description

Defined in request/request.ts:236

Parameters

Name	Details
mapper Required	DataMapper

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setDeduplicate()

Preview

setDeduplicate(deduplicate)

Description

Defined in request/request.ts:220

Parameters

Name	Details
deduplicate Required	boolean

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setDeduplicateTime()

Preview

setDeduplicateTime(deduplicateTime)

Description

Defined in request/request.ts:224

Parameters

Name	Details
deduplicateTime Required	number

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setEffectKey()

Preview

setEffectKey(effectKey)

Description

Defined in request/request.ts:215

Parameters

Name	Details
effectKey Required	string

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setGarbageCollection()

Preview

setGarbageCollection(garbageCollection)

Description

Defined in request/request.ts:182

Parameters

Name	Details
garbageCollection Required	number

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setHeaders()

Preview

setHeaders(headers)

Description

Defined in request/request.ts:143

Parameters

Name	Details
headers Required	HeadersInit

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setOffline()

Preview

setOffline(offline)

Description

Defined in request/request.ts:232

Parameters

Name	Details
offline Required	boolean

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setOptions()

Preview

setOptions(options)

Description

Defined in request/request.ts:166

Parameters

Name	Details
options Required	AdapterOptions

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, true, MappedData>

---

setParams()

Preview

setParams<P>(params)

Description

Defined in request/request.ts:151

Parameters

Name	Details
params Required	P

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, P extends null ? false : true, HasQuery, MappedData>

---

setQueryParams()

Preview

setQueryParams(queryParams)

Description

Defined in request/request.ts:162

Parameters

Name	Details
queryParams Required	QueryParams

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, true, MappedData>

---

setQueueKey()

Preview

setQueueKey(queueKey)

Description

Defined in request/request.ts:210

Parameters

Name	Details
queueKey Required	string

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setQueued()

Preview

setQueued(queued)

Description

Defined in request/request.ts:196

Parameters

Name	Details
queued Required	boolean

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setRetry()

Preview

setRetry(retry)

Description

Defined in request/request.ts:174

Parameters

Name	Details
retry Required	number

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setRetryTime()

Preview

setRetryTime(retryTime)

Description

Defined in request/request.ts:178

Parameters

Name	Details
retryTime Required	number

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---

setUsed()

Preview

setUsed(used)

Description

Defined in request/request.ts:228

Parameters

Name	Details
used Required	boolean

Return

Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>

---