Skip to main content

Interface: IJinFrameRequestConfig

Configuration for AxiosRequestConfig. Exclude headers, method, data, url, validateStatus. headers, method, data, url, validateStatus use jin-frame configuration value.

Hierarchy​

  • Omit<AxiosRequestConfig, "headers" | "method" | "data" | "url" | "validateStatus">

    ↳ IJinFrameRequestConfig

Properties​

adapter​

• Optional adapter: AxiosAdapterConfig | AxiosAdapterConfig[]

Inherited from​

Omit.adapter

Defined in​

jin-frame/node_modules/axios/index.d.ts:299

auth​

• Optional auth: AxiosBasicCredentials

Inherited from​

Omit.auth

Defined in​

jin-frame/node_modules/axios/index.d.ts:300

baseURL​

• Optional baseURL: string

Inherited from​

Omit.baseURL

Defined in​

jin-frame/node_modules/axios/index.d.ts:289

beforeRedirect​

• Optional beforeRedirect: (options: Record<string, any>, responseDetails: { headers: Record<string, string> }) => void

Type declaration​

▸ (options, responseDetails): void

Parameters​
NameType
optionsRecord<string, any>
responseDetailsObject
responseDetails.headersRecord<string, string>
Returns​

void

Inherited from​

Omit.beforeRedirect

Defined in​

jin-frame/node_modules/axios/index.d.ts:312

cancelToken​

• Optional cancelToken: CancelToken

Inherited from​

Omit.cancelToken

Defined in​

jin-frame/node_modules/axios/index.d.ts:317

decompress​

• Optional decompress: boolean

Inherited from​

Omit.decompress

Defined in​

jin-frame/node_modules/axios/index.d.ts:318

env​

• Optional env: Object

Type declaration​

NameType
FormData?(...args: any[]) => object

Inherited from​

Omit.env

Defined in​

jin-frame/node_modules/axios/index.d.ts:322

formSerializer​

• Optional formSerializer: FormSerializerOptions

Inherited from​

Omit.formSerializer

Defined in​

jin-frame/node_modules/axios/index.d.ts:325

httpAgent​

• Optional httpAgent: any

Inherited from​

Omit.httpAgent

Defined in​

jin-frame/node_modules/axios/index.d.ts:314

httpsAgent​

• Optional httpsAgent: any

Inherited from​

Omit.httpsAgent

Defined in​

jin-frame/node_modules/axios/index.d.ts:315

insecureHTTPParser​

• Optional insecureHTTPParser: boolean

Inherited from​

Omit.insecureHTTPParser

Defined in​

jin-frame/node_modules/axios/index.d.ts:321

maxBodyLength​

• Optional maxBodyLength: number

Inherited from​

Omit.maxBodyLength

Defined in​

jin-frame/node_modules/axios/index.d.ts:309

maxContentLength​

• Optional maxContentLength: number

Inherited from​

Omit.maxContentLength

Defined in​

jin-frame/node_modules/axios/index.d.ts:307

maxRate​

• Optional maxRate: number | [number, number]

Inherited from​

Omit.maxRate

Defined in​

jin-frame/node_modules/axios/index.d.ts:311

maxRedirects​

• Optional maxRedirects: number

Inherited from​

Omit.maxRedirects

Defined in​

jin-frame/node_modules/axios/index.d.ts:310

onDownloadProgress​

• Optional onDownloadProgress: (progressEvent: AxiosProgressEvent) => void

Type declaration​

▸ (progressEvent): void

Parameters​
NameType
progressEventAxiosProgressEvent
Returns​

void

Inherited from​

Omit.onDownloadProgress

Defined in​

jin-frame/node_modules/axios/index.d.ts:306

onUploadProgress​

• Optional onUploadProgress: (progressEvent: AxiosProgressEvent) => void

Type declaration​

▸ (progressEvent): void

Parameters​
NameType
progressEventAxiosProgressEvent
Returns​

void

Inherited from​

Omit.onUploadProgress

Defined in​

jin-frame/node_modules/axios/index.d.ts:305

params​

• Optional params: any

Inherited from​

Omit.params

Defined in​

jin-frame/node_modules/axios/index.d.ts:293

paramsSerializer​

• Optional paramsSerializer: ParamsSerializerOptions

Inherited from​

Omit.paramsSerializer

Defined in​

jin-frame/node_modules/axios/index.d.ts:294

proxy​

• Optional proxy: false | AxiosProxyConfig

Inherited from​

Omit.proxy

Defined in​

jin-frame/node_modules/axios/index.d.ts:316

responseEncoding​

• Optional responseEncoding: string

Inherited from​

Omit.responseEncoding

Defined in​

jin-frame/node_modules/axios/index.d.ts:302

responseType​

• Optional responseType: ResponseType

Inherited from​

Omit.responseType

Defined in​

jin-frame/node_modules/axios/index.d.ts:301

signal​

• Optional signal: GenericAbortSignal

Inherited from​

Omit.signal

Defined in​

jin-frame/node_modules/axios/index.d.ts:320

socketPath​

• Optional socketPath: null | string

Inherited from​

Omit.socketPath

Defined in​

jin-frame/node_modules/axios/index.d.ts:313

timeout​

• Optional timeout: number

Inherited from​

Omit.timeout

Defined in​

jin-frame/node_modules/axios/index.d.ts:296

timeoutErrorMessage​

• Optional timeoutErrorMessage: string

Inherited from​

Omit.timeoutErrorMessage

Defined in​

jin-frame/node_modules/axios/index.d.ts:297

transformRequest​

• Optional transformRequest: AxiosRequestTransformer | AxiosRequestTransformer[]

Inherited from​

Omit.transformRequest

Defined in​

jin-frame/node_modules/axios/index.d.ts:290

transformResponse​

• Optional transformResponse: AxiosResponseTransformer | AxiosResponseTransformer[]

Inherited from​

Omit.transformResponse

Defined in​

jin-frame/node_modules/axios/index.d.ts:291

transitional​

• Optional transitional: TransitionalOptions

Inherited from​

Omit.transitional

Defined in​

jin-frame/node_modules/axios/index.d.ts:319

userAgent​

• Optional userAgent: string

User-Agent string. Axios use Custom Use-Agent string like "axios/0.27.2". You can change that string by useAgent field.

Defined in​

jin-frame/src/interfaces/IJinFrameRequestConfig.ts:13

withCredentials​

• Optional withCredentials: boolean

Inherited from​

Omit.withCredentials

Defined in​

jin-frame/node_modules/axios/index.d.ts:298

xsrfCookieName​

• Optional xsrfCookieName: string

Inherited from​

Omit.xsrfCookieName

Defined in​

jin-frame/node_modules/axios/index.d.ts:303

xsrfHeaderName​

• Optional xsrfHeaderName: string

Inherited from​

Omit.xsrfHeaderName

Defined in​

jin-frame/node_modules/axios/index.d.ts:304