# @edgefirst-dev/data 中文文档

规范地址：https://npmcn.com/package/%40edgefirst-dev/data/

版本：0\.0\.4
npm 元数据更新时间：2025-02-17T22:33:32.621Z
中文译文更新时间：2026-11-13T06:39:36.879Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40edgefirst-dev/data
原文对照：https://npmcn.com/package/%40edgefirst-dev/data/?lang=original
项目主页：https://edgefirst-dev.github.io/data
源码仓库：https://github.com/edgefirst-dev/data

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

- 包体积（解压后）：68.6 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- 首次发布：2024-09-27T01:35:46.501Z
- 最新版本发布：2025-02-17T22:33:32.171Z
- 近 30 天下载量：295673（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

用于安全解析和处理结构化数据的TypeScript工具,使用DTO和解析器用于FormData、URLSearchParams和JSON对象.

## 安装

```sh
npm install @edgefirst-dev/data
```

也可以使用：`pnpm add @edgefirst-dev/data`、`yarn add @edgefirst-dev/data`、`bun add @edgefirst-dev/data`

## README

# @ dedgefirst-dev/ data (日语)

一个TypeScript工具库,用于安全地解析和处理来自各种来源的结构化数据,例如: `FormData`, (中文(简体) ), `URLSearchParams`JSON的物体 还有更多 这个 `Data` class 提供了定义数据传输对象(DTOs)的结构化方法,而专门的解析器则允许类型安全访问窗体字段,URL搜索参数和通用对象.

## 安装

```sh
bun add @edgefirst-dev/data
```

## 使用量

### 导入

用来使用 `Data` 类,从软件包根导入:

```ts
import { Data } from "@edgefirst-dev/data";
```

用来使用 `Parser` 基准类或专门分析器之一(`FormParser`, (中文(简体) ), `SearchParamsParser`, (中文(简体) ), `ObjectParser`,从 `parser` 模块 :

```ts
import {
  Parser,
  FormParser,
  SearchParamsParser,
  ObjectParser,
} from "@edgefirst-dev/data/parser";
```

## 数据类

这个 `Data` 类旨在定义一组属性,这些属性可以从源中解析,例如 `FormData`, (中文(简体) ), `URLSearchParams`或者JSON对象 你个小班 `Data` 以定义特定的 DTO,使用解析器提取和验证值.

### 示例

```ts
import { Data } from "@edgefirst-dev/data";
import { FormParser } from "@edgefirst-dev/data/parser";

class LoginData extends Data<FormParser> {
  get username() {
    return this.parser.string("username");
  }

  get password() {
    return this.parser.string("password");
  }
}

const formData = new FormData();
formData.append("username", "johndoe");
formData.append("password", "secret");

const loginData = new LoginData(new FormParser(formData));

console.log(loginData.username); // "johndoe"
console.log(loginData.password); // "secret"
```

## 解析器类

### 解析器基础类

这个 `Parser` class 是一个抽象的基础类,旨在解析和验证来自结构化来源的数据。 专门解析器将这一类扩展为处理特定数据类型,确保类型安全地进入需要的字段.

### 窗体辅助器

`FormParser` 是一个专门解析器,可以覆盖 `FormData` 并提供了以安全和类型验证的方式进入形成字段的方法.

#### 示例

```ts
import { FormParser } from "@edgefirst-dev/data/parser";

const formData = new FormData();
formData.append("username", "johndoe");

const parser = new FormParser(formData);

console.log(parser.string("username")); // "johndoe"
```

### 搜索守护进程

`SearchParamsParser` 从 a 提取并验证 URL 查询参数 `URLSearchParams` 对象, `URL`, (中文(简体) ), `Request`,或 URL 字符串.

#### 示例

```ts
import { SearchParamsParser } from "@edgefirst-dev/data/parser";

const url = new URL("https://example.com/?search=query");
const parser = new SearchParamsParser(url);

console.log(parser.get("search")); // "query"
```

### 对象打印器

`ObjectParser` 安全访问和验证平原 JavaScript 对象内的值,确保检索值的类型正确.

#### 示例

```ts
import { ObjectParser } from "@edgefirst-dev/data/parser";

const data = { name: "Alice", age: 30 };
const parser = new ObjectParser(data);

console.log(parser.string("name")); // "Alice"
console.log(parser.number("age")); // 30
```

## 处理错误

当验证失败时, 所有解析器类都会丢出专门错误 :

-   `Parser.MissingKeyError`: 缺少所需密钥时抛出.
-   `Parser.InvalidTypeError`: 当一个值不是预期类型时抛出.
-   `Parser.InvalidInstanceOfError`: 当一个值不是预期类的实例时丢出.
-   `Parser.CoercionError`: 当一个值不能被强制用于预期类型时被丢弃.

每一个都扩大了基础 `Parser.Error` 类,这样您就可以用单曲记录所有解析错误 `instanceof` 条件.

### 示例

```ts
import { ObjectParser } from "@edgefirst-dev/data/parser";

try {
  const data = { name: "Alice", age: 30 };
  const parser = new ObjectParser(data);
  console.log(parser.string("email")); // Throws Parser.MissingKeyError
} catch (error) {
  if (error instanceof Parser.MissingKeyError) {
    // Handle missing key error
  }
  if (error instanceof Parser.Error) {
    // Handle other parser errors
  }
  throw error; // Re-throw unexpected errors
}
```

## 许可证

见 [自由主义](https://npmcn.com/package/%40edgefirst-dev/data/LICENSE)

## 作者

-   [塞尔吉奥·沙拉姆布里](https://sergiodxa.com/)

## 常见问题

### @edgefirst-dev/data 是什么？

用于安全解析和处理结构化数据的TypeScript工具,使用DTO和解析器用于FormData、URLSearchParams和JSON对象\.

### 如何安装 @edgefirst-dev/data？

在项目目录运行 npm install @edgefirst-dev/data，或使用 pnpm add / yarn add / bun add。

### @edgefirst-dev/data 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/edgefirst-dev\_\_data 是否存在。

### @edgefirst-dev/data 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @edgefirst-dev/data 需要什么版本的 Node\.js？

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

### @edgefirst-dev/data 可以商用吗？

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

### @edgefirst-dev/data 的下载量有多少？

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

### @edgefirst-dev/data 还在维护吗？

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