# @cordisjs/unyaml 中文文档

规范地址：https://npmcn.com/package/%40cordisjs/unyaml/

版本：3\.0\.0
npm 元数据更新时间：2026-11-06T11:01:21.248Z
中文译文更新时间：2026-11-10T18:41:38.768Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：12.9 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^22\.15 \|\| \>=24
- 运行依赖：2 个
- 首次发布：2026-04-28T17:15:41.509Z
- 最新版本发布：2026-11-06T11:01:20.862Z
- 近 30 天下载量：23269（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

用于Node.js、esbuild和Vite的通用YAML装载器

## 安装

```sh
npm install @cordisjs/unyaml
```

也可以使用：`pnpm add @cordisjs/unyaml`、`yarn add @cordisjs/unyaml`、`bun add @cordisjs/unyaml`

## README

# unyaml 语句

[![downloads](https://img.shields.io/npm/dm/unyaml?style=flat-square)](https://www.npmjs.com/package/unyaml) [![npm](https://img.shields.io/npm/v/unyaml?style=flat-square)](https://www.npmjs.com/package/unyaml) [![GitHub](https://img.shields.io/github/license/shigma/unyaml?style=flat-square)](https://github.com/shigma/unyaml/blob/master/LICENSE)

通用YAML装载器. 在Node.js(CJS)工作 `require` /无害环境管理 `import`, (中文(简体) ), [兴建](https://esbuild.github.io/) 财务报告和审定财务报表 [维特](https://vitejs.dev/) - 一个包裹 一个心理模型.

## 节点.js

节点.js `^22.15 || >=24` 需要时间.

### 从CLI

CJS: 贾克:

```sh
node -r unyaml path/to/index.cjs
```

无害环境管理:

```sh
node --import unyaml path/to/index.mjs
```

### 手动导入

CJS: 贾克:

```js
require('unyaml')
require('path/to/file.yml') // now it works!
```

无害环境管理:

```js
import 'unyaml'
const data = await import('path/to/file.yml')
```

## 兴建

```js
import esbuild from 'esbuild'
import unyaml from 'unyaml/esbuild'

await esbuild.build({
  entryPoints: ['src/index.ts'],
  bundle: true,
  outfile: 'dist/index.js',
  plugins: [unyaml()],
})
```

`.yml` 编号 : `.yaml` 进口作为 JSON 模块加载、解析和内含.

### 选项

```ts
unyaml({
  filter?: RegExp                  // default: /\.ya?ml$/
  // ...plus any js-yaml LoadOptions (schema, json, onWarning, ...)
})
```

## 维特

```js
// vite.config.ts
import { defineConfig } from 'vite'
import unyaml from 'unyaml/vite'

export default defineConfig({
  plugins: [unyaml()],
})
```

Vite 插件处理主管道 **财务报告和审定财务报表** 基于构建的依赖性预捆绑(`optimizeDeps`,因此从内部导入 YAML `node_modules` 工作从盒子.

### 选项

```ts
unyaml({
  filter?: RegExp                  // default: /\.ya?ml(?:\?.*)?$/
  // ...plus any js-yaml LoadOptions (schema, json, onWarning, ...)
})
```

## 类型脚本支持

安静 `Cannot find module 'file.yml' or its corresponding type declarations.` 错误, 添加 `unyaml/types` 改为 `compilerOptions.types` 内 `tsconfig.json`数字 :

```json
{
  "compilerOptions": {
    "types": [
      "unyaml/types"
    ]
  }
}
```

## 常见问题

### @cordisjs/unyaml 是什么？

用于Node\.js、esbuild和Vite的通用YAML装载器

### 如何安装 @cordisjs/unyaml？

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

### @cordisjs/unyaml 支持 TypeScript 吗？

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

### @cordisjs/unyaml 支持 ESM 还是 CommonJS？

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

### @cordisjs/unyaml 需要什么版本的 Node\.js？

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

### @cordisjs/unyaml 可以商用吗？

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

### @cordisjs/unyaml 的下载量有多少？

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

### @cordisjs/unyaml 还在维护吗？

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