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.
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
|
|
requestOptions
|
|
requestDump
|
|
dataMapper
|
|
Properties
data
data
Description
Defined in request/request.ts:51
Type
MappedData extends never ? Payload : MappedData
requestDump
requestDump
Description
Defined in request/request.ts:78
Type
RequestCurrentType<Response, Payload, QueryParams, GlobalError | LocalError, Endpoint, AdapterOptions, MappedData>
requestOptions
requestOptions
Description
Defined in request/request.ts:77
Type
RequestOptionsType<Endpoint, AdapterOptions>
Methods
exec()
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()
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()
abort()
Preview
abort()
Description
Defined in request/request.ts:373
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
clone()
clone()
Preview
clone<D, P, Q, NewMappedData>(options, mapper)
Description
Defined in request/request.ts:304
Parameters
Name | Details |
---|---|
options
|
|
mapper
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, D, P, Q, NewMappedData>
dump()
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()
setAbortKey()
Preview
setAbortKey(abortKey)
Description
Defined in request/request.ts:200
Parameters
Name | Details |
---|---|
abortKey
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setAuth()
setAuth()
Preview
setAuth(auth)
Description
Defined in request/request.ts:147
Parameters
Name | Details |
---|---|
auth
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setCache()
setCache()
Preview
setCache(cache)
Description
Defined in request/request.ts:188
Parameters
Name | Details |
---|---|
cache
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setCacheKey()
setCacheKey()
Preview
setCacheKey(cacheKey)
Description
Defined in request/request.ts:205
Parameters
Name | Details |
---|---|
cacheKey
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setCacheTime()
setCacheTime()
Preview
setCacheTime(cacheTime)
Description
Defined in request/request.ts:192
Parameters
Name | Details |
---|---|
cacheTime
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setCancelable()
setCancelable()
Preview
setCancelable(cancelable)
Description
Defined in request/request.ts:170
Parameters
Name | Details |
---|---|
cancelable
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setData()
setData()
Preview
setData<D>(data)
Description
Defined in request/request.ts:155
Parameters
Name | Details |
---|---|
data
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, D extends null ? false : true, HasParams, HasQuery, MappedData>
setDataMapper()
setDataMapper()
Preview
setDataMapper<DataMapper>(mapper)
Description
Defined in request/request.ts:236
Parameters
Name | Details |
---|---|
mapper
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setDeduplicate()
setDeduplicate()
Preview
setDeduplicate(deduplicate)
Description
Defined in request/request.ts:220
Parameters
Name | Details |
---|---|
deduplicate
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setDeduplicateTime()
setDeduplicateTime()
Preview
setDeduplicateTime(deduplicateTime)
Description
Defined in request/request.ts:224
Parameters
Name | Details |
---|---|
deduplicateTime
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setEffectKey()
setEffectKey()
Preview
setEffectKey(effectKey)
Description
Defined in request/request.ts:215
Parameters
Name | Details |
---|---|
effectKey
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setGarbageCollection()
setGarbageCollection()
Preview
setGarbageCollection(garbageCollection)
Description
Defined in request/request.ts:182
Parameters
Name | Details |
---|---|
garbageCollection
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setHeaders()
setHeaders()
Preview
setHeaders(headers)
Description
Defined in request/request.ts:143
Parameters
Name | Details |
---|---|
headers
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setOffline()
setOffline()
Preview
setOffline(offline)
Description
Defined in request/request.ts:232
Parameters
Name | Details |
---|---|
offline
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setOptions()
setOptions()
Preview
setOptions(options)
Description
Defined in request/request.ts:166
Parameters
Name | Details |
---|---|
options
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, true, MappedData>
setParams()
setParams()
Preview
setParams<P>(params)
Description
Defined in request/request.ts:151
Parameters
Name | Details |
---|---|
params
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, P extends null ? false : true, HasQuery, MappedData>
setQueryParams()
setQueryParams()
Preview
setQueryParams(queryParams)
Description
Defined in request/request.ts:162
Parameters
Name | Details |
---|---|
queryParams
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, true, MappedData>
setQueueKey()
setQueueKey()
Preview
setQueueKey(queueKey)
Description
Defined in request/request.ts:210
Parameters
Name | Details |
---|---|
queueKey
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setQueued()
setQueued()
Preview
setQueued(queued)
Description
Defined in request/request.ts:196
Parameters
Name | Details |
---|---|
queued
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>
setRetry()
setRetry()
Preview
setRetry(retry)
Description
Defined in request/request.ts:174
Parameters
Name | Details |
---|---|
retry
|
|
Return
Request<Response, Payload, QueryParams, GlobalError, LocalError, Endpoint, AdapterOptions, HasData, HasParams, HasQuery, MappedData>