Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Latest commit

 

History

History
552 lines (297 loc) · 8.51 KB

ExtendedAxiosRequestConfig.md

File metadata and controls

552 lines (297 loc) · 8.51 KB

seamapi / Exports / ExtendedAxiosRequestConfig

Interface: ExtendedAxiosRequestConfig<URL, Method>

Type parameters

Name Type
URL extends keyof Routes
Method extends Routes[URL]["method"]

Hierarchy

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

    ExtendedAxiosRequestConfig

Table of contents

Properties

Methods

Properties

adapter

Optional adapter: AxiosAdapter

Inherited from

Omit.adapter

Defined in

node_modules/axios/index.d.ts:89


auth

Optional auth: AxiosBasicCredentials

Inherited from

Omit.auth

Defined in

node_modules/axios/index.d.ts:90


axios-retry

Optional axios-retry: IAxiosRetryConfig

Inherited from

Omit.axios-retry

Defined in

node_modules/axios-retry/index.d.ts:64


baseURL

Optional baseURL: string

Inherited from

Omit.baseURL

Defined in

node_modules/axios/index.d.ts:79


cancelToken

Optional cancelToken: CancelToken

Inherited from

Omit.cancelToken

Defined in

node_modules/axios/index.d.ts:105


data

Optional data: RouteRequestBody<URL>

Defined in

src/seam-os/client.ts:46


decompress

Optional decompress: boolean

Inherited from

Omit.decompress

Defined in

node_modules/axios/index.d.ts:106


headers

Optional headers: AxiosRequestHeaders

Inherited from

Omit.headers

Defined in

node_modules/axios/index.d.ts:82


httpAgent

Optional httpAgent: any

Inherited from

Omit.httpAgent

Defined in

node_modules/axios/index.d.ts:102


httpsAgent

Optional httpsAgent: any

Inherited from

Omit.httpsAgent

Defined in

node_modules/axios/index.d.ts:103


insecureHTTPParser

Optional insecureHTTPParser: boolean

Inherited from

Omit.insecureHTTPParser

Defined in

node_modules/axios/index.d.ts:109


maxBodyLength

Optional maxBodyLength: number

Inherited from

Omit.maxBodyLength

Defined in

node_modules/axios/index.d.ts:99


maxContentLength

Optional maxContentLength: number

Inherited from

Omit.maxContentLength

Defined in

node_modules/axios/index.d.ts:97


maxRedirects

Optional maxRedirects: number

Inherited from

Omit.maxRedirects

Defined in

node_modules/axios/index.d.ts:100


method

method: Method

Defined in

src/seam-os/client.ts:44


params

Optional params: RouteRequestParams<URL>

Overrides

Omit.params

Defined in

src/seam-os/client.ts:45


proxy

Optional proxy: false | AxiosProxyConfig

Inherited from

Omit.proxy

Defined in

node_modules/axios/index.d.ts:104


responseEncoding

Optional responseEncoding: string

Inherited from

Omit.responseEncoding

Defined in

node_modules/axios/index.d.ts:92


responseType

Optional responseType: ResponseType

Inherited from

Omit.responseType

Defined in

node_modules/axios/index.d.ts:91


signal

Optional signal: AbortSignal

Inherited from

Omit.signal

Defined in

node_modules/axios/index.d.ts:108


socketPath

Optional socketPath: null | string

Inherited from

Omit.socketPath

Defined in

node_modules/axios/index.d.ts:101


timeout

Optional timeout: number

Inherited from

Omit.timeout

Defined in

node_modules/axios/index.d.ts:86


timeoutErrorMessage

Optional timeoutErrorMessage: string

Inherited from

Omit.timeoutErrorMessage

Defined in

node_modules/axios/index.d.ts:87


transformRequest

Optional transformRequest: AxiosRequestTransformer | AxiosRequestTransformer[]

Inherited from

Omit.transformRequest

Defined in

node_modules/axios/index.d.ts:80


transformResponse

Optional transformResponse: AxiosResponseTransformer | AxiosResponseTransformer[]

Inherited from

Omit.transformResponse

Defined in

node_modules/axios/index.d.ts:81


transitional

Optional transitional: TransitionalOptions

Inherited from

Omit.transitional

Defined in

node_modules/axios/index.d.ts:107


url

url: URL

Defined in

src/seam-os/client.ts:43


validateStatus

Optional validateStatus: null | (status: number) => boolean

Inherited from

Omit.validateStatus

Defined in

node_modules/axios/index.d.ts:98


withCredentials

Optional withCredentials: boolean

Inherited from

Omit.withCredentials

Defined in

node_modules/axios/index.d.ts:88


xsrfCookieName

Optional xsrfCookieName: string

Inherited from

Omit.xsrfCookieName

Defined in

node_modules/axios/index.d.ts:93


xsrfHeaderName

Optional xsrfHeaderName: string

Inherited from

Omit.xsrfHeaderName

Defined in

node_modules/axios/index.d.ts:94

Methods

onDownloadProgress

Optional onDownloadProgress(progressEvent): void

Parameters

Name Type
progressEvent any

Returns

void

Inherited from

Omit.onDownloadProgress

Defined in

node_modules/axios/index.d.ts:96


onUploadProgress

Optional onUploadProgress(progressEvent): void

Parameters

Name Type
progressEvent any

Returns

void

Inherited from

Omit.onUploadProgress

Defined in

node_modules/axios/index.d.ts:95


paramsSerializer

Optional paramsSerializer(params): string

Parameters

Name Type
params any

Returns

string

Inherited from

Omit.paramsSerializer

Defined in

node_modules/axios/index.d.ts:84