# @alwaysmeticulous/api 中文文档

规范地址：https://npmcn.com/package/%40alwaysmeticulous/api/

版本：3\.6\.0
npm 元数据更新时间：2026-11-05T16:24:07.775Z
中文译文更新时间：2026-11-05T23:06:53.827Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：135 kB，93 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：0 个
- 首次发布：2022-11-10T17:23:16.601Z
- 最新版本发布：2026-11-05T16:24:07.334Z
- 近 30 天下载量：1647483（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：203（近 12 个月 69 个）

## 中文简介

金属 API 类型

## 安装

```sh
npm install @alwaysmeticulous/api
```

也可以使用：`pnpm add @alwaysmeticulous/api`、`yarn add @alwaysmeticulous/api`、`bun add @alwaysmeticulous/api`

## README

# 温和的API

这个软件包包含了数据库或S3所坚持的并被SDK所使用的类型定义.

既存储在数据库中又从捆绑发送到SDK或 从SDK到捆绑在sdk-bundle-api子文件夹中活. 此文件夹被分为三个子文件夹 :

-   Sdk- to- bundle 子文件夹包含从 SDK 发送到捆绑的类型
-   捆绑到 sdk 子文件夹包含从捆绑到 SDK 的类型
-   双向文件夹包含从 SDK 发送到捆绑和从捆绑到 SDK 的类型

数据库中持续存在但SDK没有使用的类型应活在主要精密的回放中, 不是这个包裹 在SDK和捆绑之间发送但不存储在数据库中的类型应当 居住在@almeticulous/sdk-bundles-api.

### 哪些变化是安全的?

对所有类型,必须保留后向相容性,因为我们代码的更新版本可能改为数据 保存在数据库中的旧方案下。 特别是意味着增加新的可选场是安全的, 几乎所有的东西都是不安全的:

-   添加所需的新字段不安全 .
-   如果在SDK/CLI中使用字段,则删除字段不安全. 旧版本的 CLI 可以读取数据 (从数据库中,或从捆绑中发送) 期望当字段不存在时它就会存在. 如果球场不是 在SDK/CLI中使用,然后可以安全删除,但您必须确保删除字段中的任何用法 在删除字段之前, 主细重播 .
-   更改字段的类型不安全 .

## 常见问题

### @alwaysmeticulous/api 是什么？

金属 API 类型

### 如何安装 @alwaysmeticulous/api？

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

### @alwaysmeticulous/api 支持 TypeScript 吗？

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

### @alwaysmeticulous/api 支持 ESM 还是 CommonJS？

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

### @alwaysmeticulous/api 需要什么版本的 Node\.js？

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

### @alwaysmeticulous/api 可以商用吗？

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

### @alwaysmeticulous/api 的下载量有多少？

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

### @alwaysmeticulous/api 还在维护吗？

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