onion-interceptor • Docs

---

类: OnionInterceptor

OnionInterceptor 类创建一个洋葱模型拦截器。 拦截器可以用于拦截和修改 HTTP 请求和响应。

Param

(可选) Axios 实例。

示例

import type { Context, Next } from 'onion-interceptor';
import { OnionInterceptor } from 'onion-interceptor';
import axios from 'axios';

const http = axios.create({
  baseURL: 'https://api.github.com/',
  headers: {
    'Content-Type': 'application/json'
  }
});

// 洋葱拦截器 实例化时可以传入类 Axios 实例 (也就意味着 可以通过 fetch 封装)
// 只需要实例上存在 request 方法，和 defaults (默认配置) 属性即可
const interceptor = new OnionInterceptor(http);

interceptor.use(async(ctx: Context, next: Next) => {
  // 在这里可以修改请求配置或执行其他操作
  await next();
});

Constructors

new OnionInterceptor()

new OnionInterceptor(instance?, useAxios?): OnionInterceptor

构造函数

参数

参数名	类型	默认值	描述
instance?	AxiosInstanceLike<RequestConfig, RequestResponse>	undefined	axios实例(可选)
useAxios?	boolean	true	是否使用的 Axios 实例 - 封装 fetch 时建议传 false (可选)

返回值类型

OnionInterceptor

查看源码

OnionInterceptor.ts:49

Methods

handle()

handle<Res>(ctx, coreFn): Promise<Res>

handle 方法用于使用洋葱拦截器拦截目标函数(是的通用性大幅提高)。

类型参数

类型参数	Value
Res	any

参数

参数名	类型	描述
ctx	Context	上下文对象。
coreFn	Function	核心函数。

返回值类型

Promise<Res>

一个 Promise，代表拦截处理的结果。

Example

// 当构造函数为传入参数，可以使用 handle 方法进行拦截处理。
const ctx = { foo: 'bar' };
interceptor.handle(ctx, async(_ctx, next) => {
  // 执行核心逻辑
  await doSomething();
  ctx.someData = 'some data';
  next();
});

查看源码

OnionInterceptor.ts:119

---

use()

use(...args): OnionInterceptor

use 方法用于添加中间件到拦截器实例。

参数

参数名	类型
...args	Middleware<Context, any>[]

返回值类型

OnionInterceptor

当前拦截器实例。

Example

class AuthMiddleware {
  async intercept(ctx: Context, next: Next) {
    // 添加认证逻辑
    await next();
  }
}

async function loadingMiddleware(ctx: Context, next: Next) {
   // loading start
   try {
     await next();
   } finally {
     // loading end
   }
}

interceptor.use(loadingMiddlewre, AuthMiddleware);
// or interceptor.use(loadingMiddlewre).use(AuthMiddleware);
// or interceptor.use(loadingMiddlewre); interceptor.use(AuthMiddleware);

查看源码

OnionInterceptor.ts:90