HttpClientOptions

Interface

{@link createHttpClient} 的配置项

Signature

interface HttpClientOptions {
    adapter: HttpAdapter
    baseURL?: string | undefined
    timeout?: number | undefined
    validateStatus?: ((status: number) => boolean) | undefined
    isBusinessSuccess?: ((response: HttpResponse) => boolean) | undefined
    unwrapBusinessData?: (<T>(response: HttpResponse) => T) | undefined
    retry?: RetryOptions | undefined
    headers?: Record<string, string> | undefined
}

Members

Name	Type	Description
adapter	HttpAdapter	传输适配器，见 `@guohanmin/http/adapters/*`
baseURLoptional	string \| undefined	—
timeoutoptional	number \| undefined	单次尝试的默认超时（毫秒），可被单次请求的 `timeout` 覆盖
validateStatusoptional	((status: number) => boolean) \| undefined	判断响应状态码是否代表成功，默认 `200 <= status < 300`
isBusinessSuccessoptional	((response: HttpResponse) => boolean) \| undefined	业务层成功判断（可选），例如按 `{code,data,message}` 约定判断 code === 0
unwrapBusinessDataoptional	(<T>(response: HttpResponse) => T) \| undefined	业务层数据解包（可选），例如把 `response.data` 替换为 `response.data.data`
retryoptional	RetryOptions \| undefined	—
headersoptional	Record<string, string> \| undefined	—

Source

packages/http/src/core/client.ts:17