# @catalystic/json-to-yaml 中文文档

规范地址：https://npmcn.com/package/%40catalystic/json-to-yaml/

版本：1\.0\.0
npm 元数据更新时间：2024-02-28T13:18:37.834Z
中文译文更新时间：2026-11-09T05:25:43.967Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40catalystic/json-to-yaml
原文对照：https://npmcn.com/package/%40catalystic/json-to-yaml/?lang=original

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

- 包体积（解压后）：4.7 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2024-02-28T13:18:37.051Z
- 最新版本发布：2024-02-28T13:18:37.291Z
- 近 30 天下载量：7282（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

将 json 转换为 yaml 的催化剂包

## 安装

```sh
npm install @catalystic/json-to-yaml
```

也可以使用：`pnpm add @catalystic/json-to-yaml`、`yarn add @catalystic/json-to-yaml`、`bun add @catalystic/json-to-yaml`

## README

### json-to-yaml (日语)

`@catalystic/json-to-yaml` 是 Javascript npm 软件包,用于在 YAML 中转换 JSON 数据.

它出口一个 `convert` 函数,用于接收 JSON 数据并输出 YAML 数据.

您可以通过标准的 JSON 或任何 Javascript 对象( 原始的, 无效的, 对任何嵌入的阵列或对象同样适用), 请检查下面的例子 .

## 使用量

**使用 Javascript 对象**

```ts
import { convert } from "@catalystic/json-to-yaml";

const json = {
  Type: "AWS::AppSync::Resolver",
  DependsOn: "GraphQLSchema",
  Properties: {
    ApiId: { "Fn::GetAtt": "GraphQLApi.ApiId" },
    DataSourceName: { "Fn::GetAtt": "UserServiceLambdaDataSource.Name" },
    TypeName: "Mutation",
    FieldName: "createUser",
    Kind: "UNIT",
    Runtime: {
      Name: "APPSYNC_JS",
      RuntimeVersion: "1.0.0",
    },
  },
};
const yaml = convert(json);

/* --- yaml ---
Type: "AWS::AppSync::Resolver"
DependsOn: "GraphQLSchema"
Properties:
  ApiId:
    Fn::GetAtt: "GraphQLApi.ApiId"
  DataSourceName:
    Fn::GetAtt: "UserServiceLambdaDataSource.Name"
  TypeName: "Mutation"
  FieldName: "createUser"
  Kind: "UNIT"
  Runtime:
    Name: "APPSYNC_JS"
    RuntimeVersion: "1.0.0"
*/
```

**使用 JSON 数据**

```ts
import { readFileSync } from "node:fs";
import { convert } from "@catalystic/json-to-yaml";

const json = readFileSync("./file-name.json");
const yaml = convert(json);
console.log(yaml);
```

## 动机

搜索 npm 登记器时, 将 json 转换为 yaml 的软件包, 我碰巧发现 [json -to - pretty - yaml (英语)](https://www.npmjs.com/package/json-to-pretty-yaml) 最近一次更新是在2018年第27日. 其两个依赖性是补救和去除-被拖动-白相间空间,它们也是最后同样更新的. 取出-trailing-whitespaces是一个单行软件包,补救是一个非常小的软件包,它们可以使用现代的javascript功能,可以被合并为一个单一的无害环境管理软件包,从而开始努力这样做并产生@catalystic/json-to-yaml.

## 常见问题

### @catalystic/json-to-yaml 是什么？

将 json 转换为 yaml 的催化剂包

### 如何安装 @catalystic/json-to-yaml？

在项目目录运行 npm install @catalystic/json-to-yaml，或使用 pnpm add / yarn add / bun add。

### @catalystic/json-to-yaml 支持 TypeScript 吗？

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

### @catalystic/json-to-yaml 支持 ESM 还是 CommonJS？

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

### @catalystic/json-to-yaml 可以商用吗？

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

### @catalystic/json-to-yaml 的下载量有多少？

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

### @catalystic/json-to-yaml 还在维护吗？

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