# @fragus/sam-types 中文文档

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

版本：1\.2\.27
npm 元数据更新时间：2026-11-13T22:38:10.120Z
中文译文更新时间：2026-11-15T11:41:15.673Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40fragus/sam-types
原文对照：https://npmcn.com/package/%40fragus/sam-types/?lang=original

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

- 包体积（解压后）：183 kB，172 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-01-28T21:47:48.566Z
- 最新版本发布：2026-11-13T22:38:09.944Z
- 近 30 天下载量：4499（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：122（近 12 个月 76 个）

## 中文简介

用于在 SAM 客户端和 SAM API 之间通信的所有类型的打字界面

## 安装

```sh
npm install @fragus/sam-types
```

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

## README

# SAM 类型

SAM-api及其客户端共享的TypeScript类型: SAM-admin-v2, SAM-超admin-frontend, SAM-webcalc-v2和"我的Page". 请求、响应、出错键和enums住在这里一次,所以API和 每个客户都同意线上的内容.

发布到 npm 为 [`@fragus/sam-types`](https://www.npmjs.com/package/@fragus/sam-types)。 。 。 .

## 用这个

每个消费者在它的精确版本 `package.json`数字 :

```json
"@fragus/sam-types": "1.1.9"
```

从软件包根导入 :

```ts
import { ContractState, INoContractsAvailableErrorParams } from '@fragus/sam-types'
```

## 先决条件

-   节点.js: 版本在 `.nvmrc`
-   无

## 开始

```bash
npm install
npm run tsc        # npm run tsc-win on Windows without bash
```

`npm run tsc` 删除编译的 `.js` 文件和再次构建软件包。 CI 运行同样的基于 每一个推.

## 文档

-   [添加和改变类型](https://npmcn.com/package/%40fragus/sam-types/docs/adding-types.md): 类型去向、命名、出口和 类型脚本3.3限制
-   [释放前对消费者进行测试](https://npmcn.com/package/%40fragus/sam-types/docs/local-development.md)数字 : `file:../SAM-types` 以及如何解除它
-   [释放](https://npmcn.com/package/%40fragus/sam-types/docs/releasing.md): 版本,发布到 npm 的 GitHub 发布,并碰上 消费者
-   [守则公约](https://npmcn.com/package/%40fragus/sam-types/docs/conventions/): 惯用词、 命名和此 repo 更改的审查栏

## 分支

`fix/`, (中文(简体) ), `feature/` 或者说 `backmerge/` 外加Kebab病例描述。 目标 `develop`。 。 。 .

## 常见问题

### @fragus/sam-types 是什么？

用于在 SAM 客户端和 SAM API 之间通信的所有类型的打字界面

### 如何安装 @fragus/sam-types？

在项目目录运行 npm install @fragus/sam-types，或使用 pnpm add / yarn add / bun add。

### @fragus/sam-types 支持 TypeScript 吗？

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

### @fragus/sam-types 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fragus/sam-types 可以商用吗？

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

### @fragus/sam-types 的下载量有多少？

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

### @fragus/sam-types 还在维护吗？

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

