Interface ApiOriginOptions

API origin option

interface ApiOriginOptions {
    adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
    auth?: AxiosBasicCredentials;
    axios-retry?: IAxiosRetryConfigExtended;
    axiosInstance?: AxiosInstance;
    baseURL?: string;
    beforeRedirect?: ((options, responseDetails) => void);
    cancelToken?: CancelToken;
    data?: any;
    decompress?: boolean;
    encodeURIParams?: boolean;
    env?: {
        FormData?: (new (...args) => object);
    };
    excludeAuthValidation?: boolean;
    family?: AddressFamily;
    formSerializer?: FormSerializerOptions;
    headers?: AxiosHeaders | Partial<RawAxiosHeaders & {
        Accept: AxiosHeaderValue;
        Authorization: AxiosHeaderValue;
        Content-Encoding: AxiosHeaderValue;
        Content-Length: AxiosHeaderValue;
        User-Agent: AxiosHeaderValue;
    } & {
        Content-Type: ContentType;
    }> & Partial<{
        delete: AxiosHeaders;
        get: AxiosHeaders;
        head: AxiosHeaders;
        link: AxiosHeaders;
        options: AxiosHeaders;
        patch: AxiosHeaders;
        post: AxiosHeaders;
        purge: AxiosHeaders;
        put: AxiosHeaders;
        unlink: AxiosHeaders;
    } & {
        common: AxiosHeaders;
    }>;
    httpAgent?: any;
    httpsAgent?: any;
    insecureHTTPParser?: boolean;
    jsonp?: boolean;
    lookup?: ((hostname, options, cb) => void) | ((hostname, options) => Promise<LookupAddress | [address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily]>);
    maxBodyLength?: number;
    maxContentLength?: number;
    maxRate?: number | [number, number];
    maxRedirects?: number;
    method?: string;
    onDownloadProgress?: ((progressEvent) => void);
    onRetry?: ((retryCount, error, requestConfig) => void);
    onUploadProgress?: ((progressEvent) => void);
    params?: any;
    paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
    passOnResponseCode?: string[];
    passOnResponseError?: boolean;
    proxy?: false | AxiosProxyConfig;
    responseEncoding?: string;
    responseType?: ResponseType;
    retries?: number;
    retryCondition?: ((error) => boolean | Promise<boolean>);
    retryDelay?: ((retryCount, error) => number);
    secured?: boolean;
    shouldResetTimeout?: boolean;
    showLoadingBar?: boolean;
    signal?: GenericAbortSignal;
    socketPath?: string;
    timeout?: number;
    timeoutErrorMessage?: string;
    tranId?: string;
    tranTypeId?: string;
    transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
    transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
    transitional?: TransitionalOptions;
    transport?: any;
    url?: string;
    validateStatus?: ((status) => boolean);
    withCredentials?: boolean;
    withXSRFToken?: boolean | ((config) => boolean);
    xsrfCookieName?: string;
    xsrfHeaderName?: string;
}

Hierarchy

RequestConfig
- ApiOriginOptions

Properties

`Optional` adapter

adapter?: AxiosAdapterConfig | AxiosAdapterConfig[]

`Optional` auth

auth?: AxiosBasicCredentials

`Optional` axios-retry

axios-retry?: IAxiosRetryConfigExtended

`Optional` axiosInstance

axiosInstance?: AxiosInstance

axiosInstance

`Optional` baseURL

baseURL?: string

`Optional` beforeRedirect

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

Type declaration

- (options, responseDetails): void
- Parameters
  - options: Record<string, any>
  - responseDetails: {
    headers: Record<string, string>;
    statusCode: HttpStatusCode;
    }
    - headers: Record<string, string>
    - statusCode: HttpStatusCode
  Returns void

`Optional` cancelToken

cancelToken?: CancelToken

`Optional` data

data?: any

`Optional` decompress

decompress?: boolean

`Optional` encodeURIParams

encodeURIParams?: boolean

params 데이터 URL 인코딩 수행 여부

Default

false

Since

3.0.2-stable

`Optional` env

env?: {
FormData?: (new (...args) => object);
}

Type declaration

Optional FormData?: (new (...args) => object)
- - new (...args): object
  - Parameters
    - Rest ...args: any[]
    Returns object

`Optional` excludeAuthValidation

excludeAuthValidation?: boolean

인증 검증 제외 여부

Default

false

`Optional` family

family?: AddressFamily

`Optional` formSerializer

formSerializer?: FormSerializerOptions

`Optional` headers

headers?: AxiosHeaders | Partial<RawAxiosHeaders & {
    Accept: AxiosHeaderValue;
    Authorization: AxiosHeaderValue;
    Content-Encoding: AxiosHeaderValue;
    Content-Length: AxiosHeaderValue;
    User-Agent: AxiosHeaderValue;
} & {
    Content-Type: ContentType;
}> & Partial<{
    delete: AxiosHeaders;
    get: AxiosHeaders;
    head: AxiosHeaders;
    link: AxiosHeaders;
    options: AxiosHeaders;
    patch: AxiosHeaders;
    post: AxiosHeaders;
    purge: AxiosHeaders;
    put: AxiosHeaders;
    unlink: AxiosHeaders;
} & {
    common: AxiosHeaders;
}>

`Optional` httpAgent

httpAgent?: any

`Optional` httpsAgent

httpsAgent?: any

`Optional` insecureHTTPParser

insecureHTTPParser?: boolean

`Optional` jsonp

jsonp?: boolean

jsonp

`Optional` lookup

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

Type declaration

- (hostname, options, cb): void
- Parameters
  - hostname: string
  - options: object
  - cb: ((err, address, family?) => void)
    - (err, address, family?): void
      Parameters
      err: Error
      address: LookupAddress | LookupAddress[]
      Optional family: AddressFamily
      Returns void
  Returns void

Type declaration

- (hostname, options): Promise<LookupAddress | [address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily]>
- Parameters
  - hostname: string
  - options: object
  Returns Promise<LookupAddress | [address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily]>

`Optional` maxBodyLength

maxBodyLength?: number

`Optional` maxContentLength

maxContentLength?: number

`Optional` maxRate

maxRate?: number | [number, number]

`Optional` maxRedirects

maxRedirects?: number

`Optional` method

method?: string

`Optional` onDownloadProgress

onDownloadProgress?: ((progressEvent) => void)

Type declaration

- (progressEvent): void
- Parameters
  - progressEvent: AxiosProgressEvent
  Returns void

`Optional` onRetry

onRetry?: ((retryCount, error, requestConfig) => void)

A callback to get notified when a retry occurs, the number of times it has occurre, and the error

Type declaration

- (retryCount, error, requestConfig): void
- A callback to get notified when a retry occurs, the number of times it has occurre, and the error
  Parameters
  - retryCount: number
  - error: AxiosError<unknown, any>
  - requestConfig: AxiosRequestConfig<any>
  Returns void

`Optional` onUploadProgress

onUploadProgress?: ((progressEvent) => void)

Type declaration

- (progressEvent): void
- Parameters
  - progressEvent: AxiosProgressEvent
  Returns void

`Optional` params

params?: any

`Optional` paramsSerializer

paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer

`Optional` passOnResponseCode

passOnResponseCode?: string[]

특정 응답 코드일 경우, 오류 처리하지 않음.

Default

['0000']

`Optional` passOnResponseError

passOnResponseError?: boolean

API 응답 코드 오류 시 PASS 여부

`Optional` proxy

proxy?: false | AxiosProxyConfig

`Optional` responseEncoding

responseEncoding?: string

`Optional` responseType

responseType?: ResponseType

`Optional` retries

retries?: number

The number of times to retry before failing default: 3

`Optional` retryCondition

retryCondition?: ((error) => boolean | Promise<boolean>)

A callback to further control if a request should be retried. default: it retries if it is a network error or a 5xx error on an idempotent request (GET, HEAD, OPTIONS, PUT or DELETE).

Type declaration

- (error): boolean | Promise<boolean>
- A callback to further control if a request should be retried. default: it retries if it is a network error or a 5xx error on an idempotent request (GET, HEAD, OPTIONS, PUT or DELETE).
  Parameters
  - error: AxiosError<unknown, any>
  Returns boolean | Promise<boolean>

`Optional` retryDelay

retryDelay?: ((retryCount, error) => number)

A callback to further control the delay between retry requests. By default there is no delay.

Type declaration

- (retryCount, error): number
- A callback to further control the delay between retry requests. By default there is no delay.
  Parameters
  - retryCount: number
  - error: AxiosError<unknown, any>
  Returns number

`Optional` secured

secured?: boolean

보안 암호화 통신 여부

Default

false

`Optional` shouldResetTimeout

shouldResetTimeout?: boolean

Defines if the timeout should be reset between retries default: false

`Optional` showLoadingBar

showLoadingBar?: boolean

로딩 바 display 여부

Default

true

`Optional` signal

signal?: GenericAbortSignal

`Optional` socketPath

socketPath?: string

`Optional` timeout

timeout?: number

`Optional` timeoutErrorMessage

timeoutErrorMessage?: string

`Optional` tranId

tranId?: string

거래아이디(undefined일 경우 신규 생성)

`Optional` tranTypeId

tranTypeId?: string

거래 유형 아이디 (고유 아이디를 사용하여 일괄 취소를 처리할 수 있다.)

Since

3.0.0-rc.5

`Optional` transformRequest

transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[]

`Optional` transformResponse

transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[]

`Optional` transitional

transitional?: TransitionalOptions

`Optional` transport

transport?: any

`Optional` url

url?: string

`Optional` validateStatus

validateStatus?: ((status) => boolean)

Type declaration

- (status): boolean
- Parameters
  - status: number
  Returns boolean

`Optional` withCredentials

withCredentials?: boolean

`Optional` withXSRFToken

withXSRFToken?: boolean | ((config) => boolean)

Type declaration

- (config): boolean
- Parameters
  - config: InternalAxiosRequestConfig<any>
  Returns boolean

`Optional` xsrfCookieName

xsrfCookieName?: string

`Optional` xsrfHeaderName

xsrfHeaderName?: string

Interface ApiOriginOptions

Hierarchy

Index

Properties

Properties

Optional adapter

Optional auth

Optional axios-retry

Optional axiosInstance

Optional baseURL

Optional beforeRedirect

Type declaration

Parameters

options: Record<string, any>

responseDetails: { headers: Record<string, string>; statusCode: HttpStatusCode; }

headers: Record<string, string>

statusCode: HttpStatusCode

Returns void

Optional cancelToken

Optional data

Optional decompress

Optional encodeURIParams

Default

Since

Optional env

Type declaration

Optional FormData?: (new (...args) => object)

Parameters

Rest ...args: any[]

Returns object

Optional excludeAuthValidation

Default

Optional family

Optional formSerializer

Optional headers

Optional httpAgent

Optional httpsAgent

Optional insecureHTTPParser

Optional jsonp

Optional lookup

Type declaration

Parameters

hostname: string

options: object

cb: ((err, address, family?) => void)

Parameters

err: Error

address: LookupAddress | LookupAddress[]

Optional family: AddressFamily

Returns void

Returns void

Type declaration

Parameters

hostname: string

options: object

Returns Promise<LookupAddress | [address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily]>

Optional maxBodyLength

Optional maxContentLength

Optional maxRate

Optional maxRedirects

Optional method

Optional onDownloadProgress

Type declaration

Parameters

progressEvent: AxiosProgressEvent

Returns void

Optional onRetry

Type declaration

Parameters

retryCount: number

error: AxiosError<unknown, any>

requestConfig: AxiosRequestConfig<any>

Returns void

Optional onUploadProgress

Type declaration

Parameters

progressEvent: AxiosProgressEvent

Returns void

Optional params

Optional paramsSerializer

`Optional` adapter

`Optional` auth

`Optional` axios-retry

`Optional` axiosInstance

`Optional` baseURL

`Optional` beforeRedirect

responseDetails: {
headers: Record<string, string>;
statusCode: HttpStatusCode;
}

`Optional` cancelToken

`Optional` data

`Optional` decompress

`Optional` encodeURIParams

`Optional` env

`Optional` FormData?: (new (...args) => object)

`Rest` ...args: any[]

`Optional` excludeAuthValidation

`Optional` family

`Optional` formSerializer

`Optional` headers

`Optional` httpAgent

`Optional` httpsAgent

`Optional` insecureHTTPParser

`Optional` jsonp

`Optional` lookup

`Optional` family: AddressFamily

`Optional` maxBodyLength

`Optional` maxContentLength

`Optional` maxRate

`Optional` maxRedirects

`Optional` method

`Optional` onDownloadProgress

`Optional` onRetry

`Optional` onUploadProgress

`Optional` params

`Optional` paramsSerializer

`Optional` passOnResponseCode

`Optional` passOnResponseError

`Optional` proxy

`Optional` responseEncoding

`Optional` responseType

`Optional` retries

`Optional` retryCondition

`Optional` retryDelay

`Optional` secured

`Optional` shouldResetTimeout

`Optional` showLoadingBar

`Optional` signal

`Optional` socketPath

`Optional` timeout

`Optional` timeoutErrorMessage

`Optional` tranId

`Optional` tranTypeId

`Optional` transformRequest

`Optional` transformResponse

`Optional` transitional

`Optional` transport

`Optional` url

`Optional` validateStatus

`Optional` withCredentials

`Optional` withXSRFToken

`Optional` xsrfCookieName

`Optional` xsrfHeaderName