Interface: Config<T>

Defined in: app/api/client/types.gen.ts:22

Extends

Omit<CreateAxiosDefaults, "auth" | "baseURL" | "headers" | "method">.Config

Extended by

RequestOptions

Type Parameters

T

T *extends* ClientOptions = ClientOptions

Properties

adapter?

optional adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]

Defined in: node_modules/axios/index.d.ts:380

Inherited from

[object Object]

allowAbsoluteUrls?

optional allowAbsoluteUrls?: boolean

Defined in: node_modules/axios/index.d.ts:370

Inherited from

[object Object]

allowedSocketPaths?

optional allowedSocketPaths?: string | string[] | null

Defined in: node_modules/axios/index.d.ts:406

Inherited from

[object Object]

auth?

optional auth?: ((auth) => AuthToken | Promise<AuthToken>) | AuthToken

Defined in: app/api/core/types.gen.ts:46

Auth token or a function returning auth token. The resolved value will be added to the request payload as defined by its security array.

Inherited from

Config.auth

axios?

optional axios?: AxiosStatic | AxiosInstance

Defined in: app/api/client/types.gen.ts:31

Axios implementation. You can use this option to provide either an

AxiosStatic or an AxiosInstance.

Default

axios

baseURL?

optional baseURL?: T["baseURL"]

Defined in: app/api/client/types.gen.ts:35

Base URL for all requests made by this client.

beforeRedirect?

optional beforeRedirect?: (options, responseDetails, requestDetails) => void

Defined in: node_modules/axios/index.d.ts:393

Parameters

options

Record<string, any>

responseDetails

headers

Record<string, string>

statusCode

[object Object]

requestDetails

headers

Record<string, string>

method

[object Object]

url

[object Object]

Returns

[object Object]

Inherited from

[object Object]

bodySerializer?

optional bodySerializer?: BodySerializer | null

Defined in: app/api/core/types.gen.ts:51

A function for serializing request body parameter. By default, JSON.stringify() will be used.

Inherited from

Config.bodySerializer

cancelToken?

optional cancelToken?: CancelToken

Defined in: node_modules/axios/index.d.ts:411

Inherited from

[object Object]

data?

optional data?: any

Defined in: node_modules/axios/index.d.ts:376

Inherited from

[object Object]

decompress?

optional decompress?: boolean

Defined in: node_modules/axios/index.d.ts:412

Inherited from

[object Object]

env?

optional env?: object

Defined in: node_modules/axios/index.d.ts:416

fetch?

optional fetch?: (input, init?) => Promise<Response>

Parameters

input

string | URL | Request

init?

[object Object]

Returns

Promise<Response>

FormData?

optional FormData?: (...args) => object

Parameters

args

...any[]

Returns

[object Object]

Request?

optional Request?: (input, init?) => Request

Parameters

input

string | URL | Request

init?

[object Object]

Returns

[object Object]

Response?

optional Response?: (body?, init?) => Response

Parameters

body?

string | ArrayBuffer | Blob | FormData | URLSearchParams | ArrayBufferView<ArrayBufferLike> | null

init?

[object Object]

Returns

[object Object]

Inherited from

[object Object]

family?

optional family?: AddressFamily

Defined in: node_modules/axios/index.d.ts:426

Inherited from

[object Object]

fetchOptions?

optional fetchOptions?: Record<string, any> | Omit<RequestInit, "headers" | "method" | "signal" | "body">

Defined in: node_modules/axios/index.d.ts:445

Inherited from

[object Object]

formDataHeaderPolicy?

optional formDataHeaderPolicy?: "legacy" | "content-only"

Defined in: node_modules/axios/index.d.ts:450

Inherited from

[object Object]

formSerializer?

optional formSerializer?: FormSerializerOptions

Defined in: node_modules/axios/index.d.ts:425

Inherited from

[object Object]

headers?

optional headers?: AxiosRequestHeaders | Record<string, unknown>

Defined in: app/api/client/types.gen.ts:42

An object containing any HTTP headers that you want to pre-populate your

Headers object with.

Overrides

Config.headers

http2Options?

optional http2Options?: Record<string, any> & object

Defined in: node_modules/axios/index.d.ts:447

Type Declaration

sessionTimeout?

optional sessionTimeout?: number

Inherited from

[object Object]

httpAgent?

optional httpAgent?: any

Defined in: node_modules/axios/index.d.ts:408

Inherited from

[object Object]

httpsAgent?

optional httpsAgent?: any

Defined in: node_modules/axios/index.d.ts:409

Inherited from

[object Object]

httpVersion?

optional httpVersion?: 1 | 2

Defined in: node_modules/axios/index.d.ts:446

Inherited from

[object Object]

insecureHTTPParser?

optional insecureHTTPParser?: boolean

Defined in: node_modules/axios/index.d.ts:415

Inherited from

[object Object]

lookup?

optional lookup?: ((hostname, options, cb) => void) | ((hostname, options) => Promise<LookupAddress | [LookupAddressEntry | LookupAddressEntry[], AddressFamily]>)

Defined in: node_modules/axios/index.d.ts:427

Inherited from

[object Object]

maxBodyLength?

optional maxBodyLength?: number

Defined in: node_modules/axios/index.d.ts:390

Inherited from

[object Object]

maxContentLength?

optional maxContentLength?: number

Defined in: node_modules/axios/index.d.ts:388

Inherited from

[object Object]

maxRate?

optional maxRate?: number | [number, number]

Defined in: node_modules/axios/index.d.ts:392

Inherited from

[object Object]

maxRedirects?

optional maxRedirects?: number

Defined in: node_modules/axios/index.d.ts:391

Inherited from

[object Object]

method?

optional method?: "CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT" | "TRACE"

Defined in: app/api/core/types.gen.ts:75

The request method.

Inherited from

Config.method

onDownloadProgress?

optional onDownloadProgress?: (progressEvent) => void

Defined in: node_modules/axios/index.d.ts:387

Parameters

progressEvent

[object Object]

Returns

[object Object]

Inherited from

[object Object]

onUploadProgress?

optional onUploadProgress?: (progressEvent) => void

Defined in: node_modules/axios/index.d.ts:386

Parameters

progressEvent

[object Object]

Returns

[object Object]

Inherited from

[object Object]

params?

optional params?: any

Defined in: node_modules/axios/index.d.ts:374

Inherited from

[object Object]

paramsSerializer?

optional paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer

Defined in: node_modules/axios/index.d.ts:375

Inherited from

[object Object]

parseReviver?

optional parseReviver?: (this, key, value, context?) => any

Defined in: node_modules/axios/index.d.ts:444

Parameters

this

[object Object]

key

[object Object]

value

[object Object]

context?

source

[object Object]

Returns

[object Object]

Inherited from

[object Object]

proxy?

optional proxy?: false | AxiosProxyConfig

Defined in: node_modules/axios/index.d.ts:410

Inherited from

[object Object]

querySerializer?

optional querySerializer?: QuerySerializer | QuerySerializerOptions

Defined in: app/api/core/types.gen.ts:86

A function for serializing request query parameters. By default, arrays will be exploded in form style, objects will be exploded in deepObject style, and reserved characters are percent-encoded.

This method will have no effect if the native paramsSerializer() Axios API function is used.

View examples

Inherited from

Config.querySerializer

redact?

optional redact?: string[]

Defined in: node_modules/axios/index.d.ts:451

Inherited from

[object Object]

requestValidator?

optional requestValidator?: (data) => Promise<unknown>

Defined in: app/api/core/types.gen.ts:92

A function validating request data. This is useful if you want to ensure the request conforms to the desired shape, so it can be safely sent to the server.

Parameters

data

[object Object]

Returns

Promise<unknown>

Inherited from

Config.requestValidator

responseEncoding?

optional responseEncoding?: StringLiteralsOrString<responseEncoding>

Defined in: node_modules/axios/index.d.ts:383

Inherited from

[object Object]

responseTransformer?

optional responseTransformer?: (data) => Promise<unknown>

Defined in: app/api/core/types.gen.ts:97

A function transforming response data before it's returned. This is useful for post-processing data, e.g. converting ISO strings into Date objects.

Parameters

data

[object Object]

Returns

Promise<unknown>

Inherited from

Config.responseTransformer

responseType?

optional responseType?: ResponseType

Defined in: node_modules/axios/index.d.ts:382

Inherited from

[object Object]

responseValidator?

optional responseValidator?: (data) => Promise<unknown>

Defined in: app/api/core/types.gen.ts:103

A function validating response data. This is useful if you want to ensure the response conforms to the desired shape, so it can be safely passed to the transformers and returned to the user.