# @flatfile/hooks 中文文档

规范地址：https://npmcn.com/package/%40flatfile/hooks/

版本：1\.6\.0
npm 元数据更新时间：2026-04-23T23:54:15.787Z
中文译文更新时间：2026-11-14T21:47:13.351Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：26.3 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-12-13T20:57:03.777Z
- 最新版本发布：2024-12-06T20:22:16.148Z
- 近 30 天下载量：907208（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

### 平面文件记录

## 安装

```sh
npm install @flatfile/hooks
```

也可以使用：`pnpm add @flatfile/hooks`、`yarn add @flatfile/hooks`、`bun add @flatfile/hooks`

## README

# @ flatfile/ hooks (缩写)

### 平面文件记录

这个 `FlatfileRecord` class 代表一个记录,它具有操纵和检索字段值、元数据以及处理错误、警告和注释等记录信息的方法。 总的来说,它提供了一种方便的方法,用以处理个别数据记录,并对这些记录进行操作.

-   Flatfile Record有各种获取和修改记录数据的方法.
-   它还提供了在记录中添加信息、评论、错误和警告的方法.
-   计算、计算(IfPresent)和验证方法对记录的特定领域进行计算和验证.
-   ToJSON方法返回了JSON对记录的描述和相关信息.

### 平面文件记录

这个 `FlatfileRecords` 类代表集合 `FlatfileRecord` 实例。 它需要一系列原始记录(IRawRecord)作为输入,并创建一系列 `FlatfileRecord` 通过将每个原始记录映射到一个 `FlatfileRecord` 举个例子 这个 `FlatfileRecords` 类提供了记录属性以访问记录的数组和一个toJSON方法,通过调用每个个人的toJSON方法,将收集的记录转换为JSON格式 `FlatfileRecord`。 。 。 .

### 平面会议

这个 `FlatfileSession` 类封装 IPayload 界面的实例。 它有各种获取方法,可以访问有效载荷的不同特性.

-   工作空间ID:从有效载荷中获取工作空间ID.
-   工作手册Id:从有效载荷中获取工作手册ID.
-   schemaId:从有效载荷中获取 schema ID.
-   schemaSlug:从有效载荷中取出schema sults.
-   上传:从有效载荷取回上传阵列.
-   最终用户:从有效载荷取回最终用户物体.
-   行:从有效载荷取取行阵列.
-   env:从有效载荷中取出env物体.
-   envSignature:从有效载荷取回envSignature值.

通过创建实例 `FlatfileSession` 使用有效载荷的类别,您可以方便地使用所提供的获取器方法访问有效载荷特性.

### 开始吧

`FlatfileRecord` 现在折叠到 [@ fallowfile/plugin-record-hook (英语)](https://flatfile.com/docs/plugins/transform/record-hook) 和最常用的在这里.

## 常见问题

### @flatfile/hooks 是什么？

平面文件记录

### 如何安装 @flatfile/hooks？

在项目目录运行 npm install @flatfile/hooks，或使用 pnpm add / yarn add / bun add。

### @flatfile/hooks 支持 TypeScript 吗？

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

### @flatfile/hooks 支持 ESM 还是 CommonJS？

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

### @flatfile/hooks 可以商用吗？

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

### @flatfile/hooks 的下载量有多少？

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

### @flatfile/hooks 还在维护吗？

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