Karin API Docs / pingRequest

函数: pingRequest()

pingRequest<D, T, R>(urls, config): Promise<PingRequestResult<T, R>>

定义于: packages/core/src/utils/request/race.ts:96

测试网络请求

类型参数

D

D = any

请求数据类型

T

T extends boolean = false

是否返回详细信息

R

R extends boolean = false

是否为竞速模式

参数

urls

string[]

请求地址数组

config

ExtendedAxiosRequestConfig<D, T, R> = ...

扩展的请求配置，包含成功状态码列表和是否返回详细信息选项

返回

Promise<PingRequestResult<T, R>>

根据配置返回不同格式的结果

Examples

const urls = ['https://api.github.com', 'https://api.gitee.com']
const data = await pingRequest(urls)
console.log(data)
// -> ['https://api.github.com']

const urls = ['https://api.github.com', 'https://api.gitee.com']
const data = await pingRequest(urls, { detailed: true })
console.log(data)
// -> [{ url: 'https://api.github.com', success: true, duration: 100, error: null }]

const urls = ['https://api.github.com', 'https://api.gitee.com']
const data = await pingRequest(urls, { isRace: true })
console.log(data)
// -> 'https://api.github.com' 启用竞速模式，返回第一个成功的请求结果