# @gravity-ui/axios-wrapper 中文文档

规范地址：https://npmcn.com/package/%40gravity-ui/axios-wrapper/

版本：1\.5\.1
npm 元数据更新时间：2024-09-18T11:19:12.808Z
中文译文更新时间：2026-11-16T23:45:02.432Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gravity-ui/axios-wrapper
原文对照：https://npmcn.com/package/%40gravity-ui/axios-wrapper/?lang=original
项目主页：https://github.com/gravity-ui/axios-wrapper#readme
源码仓库：https://github.com/gravity-ui/axios-wrapper

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：32.1 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：axios ^1\.3\.4，lodash ^4\.17\.11
- 首次发布：2022-11-29T14:08:10.631Z
- 最新版本发布：2024-09-18T11:19:12.554Z
- 近 30 天下载量：36603（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

用于包装轴线呼叫的普通助手类

## 安装

```sh
npm install @gravity-ui/axios-wrapper
```

也可以使用：`pnpm add @gravity-ui/axios-wrapper`、`yarn add @gravity-ui/axios-wrapper`、`bun add @gravity-ui/axios-wrapper`

## README

# Axios 剪辑器

这个库提供了Axios周围的方便包装器,增加了自动取消同时提出的请求 它的特征.

## 安装

```shell
npm install --save-dev @gravity-ui/axios-wrapper
```

## HTTP API 密码

### 构造参数

##### 配置 \[可选\]

一个 `axios` 举个例子.

##### 收藏器 \[可选\]

请求收藏器的配置是一个对象:

```json
{
    "collectErrors": 10,
    "collectRequests": 10
}
```

### 基本方法

Wrapper 提供 http- 方法 `get`, (中文(简体) ), `head`, (中文(简体) ), `put`, (中文(简体) ), `post`, (中文(简体) ), `delete`。 。 。 .

方法 `get` 财务报告和审定财务报表 `head` 有签名 `(url, params, options)`· ; `put`, (中文(简体) ), `post`,则 `delete` 方法 已经 `(url, data, params, options)` 签名.

这个 `params` 参数表示查询字符串参数时 `options` 是请求设置.

目前支持4个请求设置 :

-   `concurrentId (string)`: 可选请求编号
-   `collectRequest (bool)`: 可选标记, 显示请求是否为日志( 默认) `true`(中文(简体) )
-   `requestConfig (object)`: 可选配置自定义请求参数
-   `headers (object)`: 带有自定义请求头的可选对象.
-   `timeout (number)`: 可选请求超时
-   `onDownloadProgress (function)`: 处理文件下载进度的可选回调

### 页眉

这个 `setDefaultHeader({name (string), value (string), methods (array)})` 方法允许添加默认 请求头.

参数 `name` 财务报告和审定财务报表 `value` 需要,可选参数 `methods` 指定所有获取这些方法的方法 默认信头(默认所有方法都会得到这些信头).

### 中国证监会

这个 `setCSRFToken` 方法允许指定 CSRF- token, 它将添加到所有 `put`, (中文(简体) ), `post` 财务报告和审定财务报表 `delete` 请求.

### 同时提出的请求

有时,如果不再需要飞行结果,最好取消飞行中的请求。 来做这个 发生的时候,人们应该通过请求 `options` 页:1 `concurrentId` 编号. 当下一个相同的请求 `concurrentId` 发生上一个请求,该 id 将被取消.

也通过援引 `cancelRequest(concurrentId)` 方法.

### 收集请求

可以使用 `collector` 选项。 它储存 所有要求和错误都分开。 以下内容: `apiInstance` 将保留最后10项请求(均成功) 以及最后10项错误请求.

```javascript
const apiInstance = new API({
    collector: {
        collectErrors: 10,
        collectRequests: 10
    }
});
```

要得到保存的请求,必须引用 `getCollectedRequests` 返回对象的方法 `{errors: [...], requests: [...]}`。 。 。 .

### 使用量

建议的用法是把基地细分 `AxiosWrapper` 类 :

```javascript
export class API extends AxiosWrapper {
    getProjects() {
        return this.get('/projects');
    }
    getSensors({project, selectors}) {
        return this.get(`/projects/${project}/sensors`, {selectors, pageSize: 200});
    }
    getNames({project, selectors}) {
        return this.get(`/projects/${project}/sensors/names`, {selectors});
    }
    getLabels({project, names, selectors}) {
        return this.get(`/projects/${project}/sensors/labels`, {names, selectors});
    }
}
```

当 `baseURL` 参数传入 `axios` 配置, 所有请求的路径名将附在其中 .

```javascript
const apiInstance = new API({
    config: {
        baseURL: '/api/v2'
    }
});
```

## 常见问题

### @gravity-ui/axios-wrapper 是什么？

用于包装轴线呼叫的普通助手类

### 如何安装 @gravity-ui/axios-wrapper？

在项目目录运行 npm install @gravity-ui/axios-wrapper，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：axios（^1\.3\.4）、lodash（^4\.17\.11）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gravity-ui/axios-wrapper 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gravity-ui/axios-wrapper 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gravity-ui/axios-wrapper 可以商用吗？

@gravity-ui/axios-wrapper 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gravity-ui/axios-wrapper 的下载量有多少？

根据 npm 官方下载统计，@gravity-ui/axios-wrapper 在 2026/10/17 – 2026/11/15 这 30 天内被下载 36,603 次，日均约 1,220 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gravity-ui/axios-wrapper 还在维护吗？

最新版本 1\.5\.1 发布于 2024/09/18（2 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/11/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

