# @amos\.com/node 中文文档

规范地址：https://npmcn.com/package/%40amos.com/node/

版本：0\.1\.78
npm 元数据更新时间：2026-11-06T21:23:30.853Z
中文译文更新时间：2026-11-06T07:27:04.574Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.2 MB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：1 个
- 首次发布：2026-05-12T20:15:24.971Z
- 最新版本发布：2026-11-06T21:23:30.599Z
- 近 30 天下载量：4174（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：77（近 12 个月 77 个）

## 中文简介

阿莫斯付费API的Node.js客户端.

## 安装

```sh
npm install @amos.com/node
```

也可以使用：`pnpm add @amos.com/node`、`yarn add @amos.com/node`、`bun add @amos.com/node`

## README

# 阿莫斯( Amos)

输入的节点客户端 **阿莫斯付费** API 从 OpenAPI 光谱中生成 [`openapi-typescript`](https://openapi-ts.dev/) 和动力 [`openapi-fetch`](https://openapi-ts.dev/openapi-fetch)。 。 。 .

> **文档 :** 完全的 Amos API 参考生活于 [docs.amos.com (英语)](https://docs.amos.com/)。这个软件包是该API的已键入的节点.js绑定.

## 安装

```bash
npm install @amos.com/node
```

## 快开始

```ts
import {
  createPayApiClient,
  AMOS_API_BASE_URL_PRODUCTION,
  AMOS_API_VERSION,
} from "@amos.com/node";

const pay = createPayApiClient({
  baseUrl: AMOS_API_BASE_URL_PRODUCTION,
  headers: {
    "X-Api-Key": process.env.AMOS_API_KEY!,
    "X-Api-Version": AMOS_API_VERSION,
  },
});

const { data, error } = await pay.POST("/customers", {
  body: { customer: { email: "alex@example.com" } },
});

if (error) {
  console.error(error);
} else {
  console.log(data);
}
```

### 沙盒模式

交换基准 URL 常数 :

```ts
import {
  createPayApiClient,
  AMOS_API_BASE_URL_SANDBOX,
  AMOS_API_VERSION,
} from "@amos.com/node";

const pay = createPayApiClient({
  baseUrl: AMOS_API_BASE_URL_SANDBOX,
  headers: {
    "X-Api-Key": process.env.AMOS_API_KEY!,
    "X-Api-Version": AMOS_API_VERSION,
  },
});
```

### 自定义基址或获取

`createPayApiClient` 接受其中任何一项 [`openapi-fetch`是因为 `ClientOptions`](https://openapi-ts.dev/openapi-fetch/api#create-client),所以你可以指向代理或供应自己的 `fetch`数字 :

```ts
const pay = createPayApiClient({
  baseUrl: "https://my-proxy.example.com",
  fetch: customFetchImpl,
  headers: {
    "X-Api-Key": process.env.AMOS_API_KEY!,
    "X-Api-Version": AMOS_API_VERSION,
    "X-Trace-Id": "abc123",
  },
});
```

### 中件( 如新鲜的一能键)

```ts
import type { Middleware } from "@amos.com/node";

const idempotencyKey: Middleware = {
  async onRequest({ request }) {
    if (request.method === "POST") {
      request.headers.set("Idempotency-Key", crypto.randomUUID());
    }
    return request;
  },
};

pay.use(idempotencyKey);
```

## API 表面

```ts
import {
  createPayApiClient,
  AMOS_API_BASE_URL_PRODUCTION,
  AMOS_API_BASE_URL_SANDBOX,
  AMOS_API_VERSION,
} from "@amos.com/node";
import type { PayApiClient, ClientOptions, Middleware } from "@amos.com/node";
```

-   `createPayApiClient(options)` ——返回已键入 [`openapi-fetch`](https://openapi-ts.dev/openapi-fetch) 客户端。 暴露满地 `openapi-fetch` 接口 : `GET`, (中文(简体) ), `POST`, (中文(简体) ), `PUT`, (中文(简体) ), `DELETE`, (中文(简体) ), `OPTIONS`, (中文(简体) ), `HEAD`, (中文(简体) ), `PATCH`, (中文(简体) ), `TRACE`, (中文(简体) ), `use`, (中文(简体) ), `eject`。 。 。 .
-   `AMOS_API_BASE_URL_PRODUCTION` 编号 : `AMOS_API_BASE_URL_SANDBOX` ——两种环境的基础URL.
-   `AMOS_API_VERSION` - 电线层 `X-Api-Version` 这个目标。 传之为道 `X-Api-Version` 每个请求的页眉( 作为默认在 `headers`页:1.
-   `PayApiClient` ——返回的类型 `createPayApiClient`。 。 。 .
-   `ClientOptions`, (中文(简体) ), `Middleware` - 从 `openapi-fetch` 为方便.

## 类型

所有计划类型均从主条目再出口。 例如:

```ts
import type { components, paths, operations } from "@amos.com/node";

type Customer = components["schemas"]["Customer"];
```

## 版本

我们跟着 **交换器** npm 软件包,附加一条规则: **主要版本跟踪线层 `X-Api-Version` 标题**。 。 。 .

| npm 范围 | `X-Api-Version` 它的目标 |
| --- | --- |
| `@amos.com/node@1.x` | `1` |
| `@amos.com/node@2.x` | `2` (假说) |

如此颠倒 `AMOS_API_VERSION` 总是一个主要的发布, 消费者谁支持 `@amos.com/node@^1` 知道他们永远不会被透明地升级 到一个新的电线合同.

颠倒的心理规则: _"会有一个程序 键入前一个 `dist/index.d.ts` 仍与新作相打字"_ 若无是道是道.

> **预1.0提醒.** 当我们开始的时候 `0.x`, (中文(简体) ), **打破更改可以降落在任意 `0.x` 释放.** 严格的SemVer(和上面的API-version-tracks-Major 规则)从我们剪接的那天开始 `1.0.0`。精确地说 `0.x.y` 如果你今天需要稳定的话.

## 常见问题

### @amos\.com/node 是什么？

阿莫斯付费API的Node\.js客户端\.

### 如何安装 @amos\.com/node？

在项目目录运行 npm install @amos\.com/node，或使用 pnpm add / yarn add / bun add。

### @amos\.com/node 支持 TypeScript 吗？

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

### @amos\.com/node 支持 ESM 还是 CommonJS？

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

### @amos\.com/node 需要什么版本的 Node\.js？

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

### @amos\.com/node 可以商用吗？

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

### @amos\.com/node 的下载量有多少？

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

### @amos\.com/node 还在维护吗？

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