createHttpAborter
创建请求中断控制器
createHttpAborter 是 Oiyo 数据获取模块提供的中断控制器工厂,用于中断进行中的请求。
声明
创建中断控制器。
createHttpAborter(): HttpAborter
返回的控制器包含以下成员:
| 成员 | 类型 | 说明 |
|---|---|---|
signal | HttpAbortSignal | 传入请求配置的 signal 字段 |
abort | function | 触发中断 |
用法
把 signal 传入请求配置,就能在任意时刻通过 abort() 中断请求。
const aborter = createHttpAborter()
const promise = http.request('/pet/1', { signal: aborter.signal })
// 任意时刻中断
aborter.abort()
try {
await promise
}
catch (error) {
// 中断错误 error.name === 'AbortError'
}
行为
- 中断信号触发后请求会立即 reject(
error.name === 'AbortError')。 - 覆盖钩子阶段与请求进行中阶段。
- 已中断的信号传入会让请求立即中断。