# @flatfile/util-response-rejection 中文文档

规范地址：https://npmcn.com/package/%40flatfile/util-response-rejection/

版本：1\.6\.0
npm 元数据更新时间：2026-04-23T23:55:01.424Z
中文译文更新时间：2026-11-14T22:01:09.668Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/util-response-rejection
原文对照：https://npmcn.com/package/%40flatfile/util-response-rejection/?lang=original
项目主页：https://github.com/FlatFilers/flatfile-plugins#readme
源码仓库：https://github.com/FlatFilers/flatfile-plugins

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

- 包体积（解压后）：50.3 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：1 个
- peer 依赖：@flatfile/api ^1\.9\.19
- 首次发布：2023-09-17T16:48:46.739Z
- 最新版本发布：2024-11-07T20:50:11.650Z
- 近 30 天下载量：8576（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 0 个）

## 中文简介

此插件处理从外部源返回的响应拒绝 .

## 安装

```sh
npm install @flatfile/util-response-rejection
```

也可以使用：`pnpm add @flatfile/util-response-rejection`、`yarn add @flatfile/util-response-rejection`、`bun add @flatfile/util-response-rejection`

## README

这个 `@flatfile/util-response-rejection` 用于处理外部源的响应拒绝。 它被设计成在"Egres"收听器中用作拒绝响应处理器.

![Response Rejection](https://raw.githubusercontent.com/FlatFilers/Guides/main/images/guides/plugins/response_rejection.png)

## 使用量

目的 `@flatfile/util-response-rejection` 工具是处理一些记录的情况 在侵略过程中被拒绝。 这个 `responseRejectionHandler` 函数旨在 使用包含被否决的记录的一组工作表,然后按 标记违法的记录字段,并带有返回的拒绝信息,说明为什么 拒绝。 如果响应值为 `deleteSubmitted` 实值 `true`,成功提交的数值 将从工作表中删除。 若为 `deleteSubmitted` 虚假或未提供,a `Submission Status` 字段被添加到工作表,每个记录被设定为“提交”或“拒绝”。 最终, 它返回在所有工作表中可以使用的所有被拒绝的记录的总数 补全信息.

```bash
npm i @flatfile/util-response-rejection
```

```ts
import {
  responseRejectionHandler,
  RejectionResponse,
} from "@flatfile/util-response-rejection";
```

### **拒绝处理器函数**

-   这个 `responseRejectionHandler` 函数是工具的主要切入点。 它需要一个参数:
    -   `responseRejection`: 包含拒绝数据的对象。 此对象的结构由 `RejectionResponse` 接口.
-   这个 `responseRejectionHandler` 函数返回 a `Promise` 决心 `number` 代表所有工作表中被拒绝的记录总数.

```ts
listener.on(
  "job:ready",
  { job: "workbook:submitActionFg" },
  async ({ context: { jobId } }) => {
    // ...
    const response = await axios.post("https://webhook.site/...", data, {
      headers: {
        "Content-Type": "application/json",
      },
    });

    const rejections: RejectionResponse = response.data.rejections;
    if (rejections) {
      return await responseRejectionHandler(rejections);
    }
    // ...
  }
);
```

### **拒绝响应接口**

这个 `RejectionResponse` 界面定义 `responseRejection` 传输到 `responseRejectionHandler` 函数。 这个 `RejectionResponse`'结构如下:

```ts
{ // RejectionResponse interface
  id: string; // The Workbook ID
  message: "Success! All records are valid.", // Optional
  deleteSubmitted: true, // Optional
  sheets: [
    { // SheetRejections interface
      sheetId: string; // The Sheet ID
      rejectedRecords: [
        { // RecordRejections interface
          id: string; // The Record ID
          values: [
            {
              field: string; // The field key
              message: string;
            }
          ];
        }
        // other rejected records...
      ];
    }
    // other sheets...
  ];
}
```

这个 `message` 属性是可选的。 如果提供, 此信件将显示给用户 。 这一电文应当设定为中选提交书或否决提交书. 这个 `deleteSubmitted` 属性是可选的。 如果选中, 成功提交的值将从工作表中删除 。 如果虚假或未提供,a `Submission Status` 字段被添加到工作表,每个记录被设定为“提交”或“拒绝”.

### **帮助函数**

-   代码中包含一个辅助功能,用于协助"平面文件工作表"更新进程:
    -   `updateSheet`: 更新平面文件 工作表将返回的拒绝信件作为错误信件添加到记录中 .

### **类型定义**

-   代码定义了三个接口: `RejectionResponse`, (中文(简体) ), `SheetRejections` 财务报告和审定财务报表 `RecordRejections`。这些接口代表了 `responseRejectionHandler()`。 。 。 .

## 常见问题

### @flatfile/util-response-rejection 是什么？

此插件处理从外部源返回的响应拒绝 \.

### 如何安装 @flatfile/util-response-rejection？

在项目目录运行 npm install @flatfile/util-response-rejection，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@flatfile/api（^1\.9\.19）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flatfile/util-response-rejection 支持 TypeScript 吗？

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

### @flatfile/util-response-rejection 支持 ESM 还是 CommonJS？

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

### @flatfile/util-response-rejection 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @flatfile/util-response-rejection 可以商用吗？

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

### @flatfile/util-response-rejection 的下载量有多少？

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

### @flatfile/util-response-rejection 还在维护吗？

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