# @guardian/newsletter-types 中文文档

规范地址：https://npmcn.com/package/%40guardian/newsletter-types/

版本：5\.0\.0
npm 元数据更新时间：2026-06-10T10:20:47.205Z
中文译文更新时间：2026-11-17T02:49:51.381Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40guardian/newsletter-types
原文对照：https://npmcn.com/package/%40guardian/newsletter-types/?lang=original
项目主页：https://github.com/guardian/csnx#readme
源码仓库：https://github.com/guardian/csnx

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

- 包体积（解压后）：19.5 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：tslib ^2\.8\.1，typescript ~6\.0\.3
- 首次发布：2023-10-05T09:30:36.144Z
- 最新版本发布：2026-06-10T10:20:46.780Z
- 近 30 天下载量：10792（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 6 个）

## 中文简介

描述 Guardian 通讯 API 产出的一组类型

## 安装

```sh
npm install @guardian/newsletter-types
```

也可以使用：`pnpm add @guardian/newsletter-types`、`yarn add @guardian/newsletter-types`、`bun add @guardian/newsletter-types`

## README

# 通讯

与监护人编辑通讯有关的类型.

《THE通讯》 API,以及管理编辑通讯的UI,服务于: [https://github.com/guardian/newsletters-nx 页面存档备份,存于互联网档案馆](https://github.com/guardian/newsletters-nx)。该项目对本软件包所服务的类型有自己的内部定义,但没有发布类型库.

此 libray 导出的类型包含 API 数据上的一个字段子集 。 仅与通讯工具内部工作流程有关的领域不包括在内.

一些打字项目通过身份API获取通讯数据([https://github.com/guardian/identity (中文(简体) )](https://github.com/guardian/identity)) (中文(简体) ). 身份从通讯API中获取数据,并以修改后的格式为它服务. 代表两种格式的类型都导出.

**这样做** - 添加代表身份格式的类型,当身份更新后使用当前数据模型.

## 常见问题

### @guardian/newsletter-types 是什么？

描述 Guardian 通讯 API 产出的一组类型

### 如何安装 @guardian/newsletter-types？

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

### @guardian/newsletter-types 支持 TypeScript 吗？

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

### @guardian/newsletter-types 支持 ESM 还是 CommonJS？

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

### @guardian/newsletter-types 可以商用吗？

@guardian/newsletter-types 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @guardian/newsletter-types 的下载量有多少？

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

### @guardian/newsletter-types 还在维护吗？

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

