# @aghanim-sdk/checkout 中文文档

规范地址：https://npmcn.com/package/%40aghanim-sdk/checkout/

版本：0\.5\.2
npm 元数据更新时间：2026-10-21T16:55:31.981Z
中文译文更新时间：2026-11-06T06:53:22.720Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aghanim-sdk/checkout
原文对照：https://npmcn.com/package/%40aghanim-sdk/checkout/?lang=original
项目主页：https://docs.aghanim.com/checkout/javascript-sdk

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

- 包体积（解压后）：737 kB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-08-13T13:21:49.690Z
- 最新版本发布：2026-10-21T16:55:31.474Z
- 近 30 天下载量：4297（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

Aghanim 退赛 JS SDK – 通过 Aghanim 退赛接受支付而不离开您的网页游戏

## 安装

```sh
npm install @aghanim-sdk/checkout
```

也可以使用：`pnpm add @aghanim-sdk/checkout`、`yarn add @aghanim-sdk/checkout`、`bun add @aghanim-sdk/checkout`

## README

# @aghanim-sdk/ 检查出局

在您的网页游戏中接受付款 [阿加尼姆(英语:Aghanim)](https://aghanim.com/) 取出 — 没有页空出, 没有服务器侧运行时间 .

📖 **全向导 : [docs.aghanim.com/checkout/javascript-sdk 页面存档备份,存于互联网档案馆](https://docs.aghanim.com/checkout/javascript-sdk)**

## 安装

```bash
npm install @aghanim-sdk/checkout
```

或通过脚本标记( 曝光) `window.Aghanim`:

```html
<script src="https://cdn.jsdelivr.net/npm/@aghanim-sdk/checkout/dist/aghanim-checkout.global.js"></script>
```

## 快开始

```ts
import { Aghanim } from "@aghanim-sdk/checkout";

// Key from Dashboard → Integration → API keys.
const aghanim = Aghanim.init({ apiKey: "sdk_..." });

// As soon as your game knows who the player is;
// clearPlayerId() on sign-out.
aghanim.setPlayerId("player_1");

const order = await aghanim.orders.create({ items: [{ sku: "gems-100" }] });
const checkout = await aghanim.openCheckout(order);

checkout
  .onPaid(() => showSuccessUI())
  .onClosed(() => game.resume());
```

这个SDK创建的命令是可消耗的. `paid` 只是一个 UX 信号: 来自 `item.add` 或将未完成的清单排出靴子、恢复和之后 `paid`。 。 。 .

```ts
// Always grant first — consuming the same order twice fails.
for (const order of await aghanim.orders.unconsumedDetails()) {
  grantToPlayer(order.items);
  await aghanim.orders.consume(order.id);
}
```

已经创建命令服务器侧吗 ? 通过不透明 `checkout_url` 直接穿过 :

```ts
const checkout = await aghanim.openCheckout(checkoutUrlFromYourBackend);
```

## 没有后端开发

```ts
const aghanim = Aghanim.init({
  apiKey: "sdk_mock",
  mock: { scenario: "instant_success" },
});
```

假设情况(`instant_success`, (中文(简体) ), `open_external`, (中文(简体) ), `three_ds`, (中文(简体) ), `failure`, (中文(简体) ), `load_error`, (中文(简体) ), `poll_fallback`, (中文(简体) ), `unconsumed`通过真实解析管道播放脚本事件. 见 `examples/`。 。 。 .

## 参考文献

-   演示文稿模式( E)`overlay`, (中文(简体) ), `embedded`, (中文(简体) ), `external`, (中文(简体) ), `auto`),事件,选项,授予: [docs.aghanim.com/checkout/javascript-sdk 页面存档备份,存于互联网档案馆](https://docs.aghanim.com/checkout/javascript-sdk)
-   仅线级类型 : `import type { OrderRead } from "@aghanim-sdk/checkout/protocol"`
-   常绿浏览器(ES2020),零运行时间依赖.

## 常见问题

### @aghanim-sdk/checkout 是什么？

Aghanim 退赛 JS SDK – 通过 Aghanim 退赛接受支付而不离开您的网页游戏

### 如何安装 @aghanim-sdk/checkout？

在项目目录运行 npm install @aghanim-sdk/checkout，或使用 pnpm add / yarn add / bun add。

### @aghanim-sdk/checkout 支持 TypeScript 吗？

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

### @aghanim-sdk/checkout 支持 ESM 还是 CommonJS？

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

### @aghanim-sdk/checkout 可以商用吗？

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

### @aghanim-sdk/checkout 的下载量有多少？

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

### @aghanim-sdk/checkout 还在维护吗？

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