# @codesandbox/api 中文文档

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

版本：1\.1\.3
npm 元数据更新时间：2025-04-29T15:22:47.055Z
中文译文更新时间：2026-11-10T07:51:10.728Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：698 kB，108 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2024-12-12T13:23:57.073Z
- 最新版本发布：2025-01-29T17:26:24.553Z
- 近 30 天下载量：22415（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

密码箱 API

## 安装

```sh
npm install @codesandbox/api
```

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

## README

# @ codesandbox/ api (帮助)

## 还需要做的事

-   [ ] 为 GQL 写钩子测试
-   [ ] 写给安息的钩子测试
-   [ ] 为 GQL 订阅提供 WebSocket 连接
-   [ ] 更多文档

## 开始吧

```ts
import { CodeSandboxApi, onBrowserRequest } from "@codesandbox/api";

const api = new CodeSandboxApi({
  // Which endpoint to use
  development: true,
  // If it should start in an authenticated state, verifying
  // the user
  authenticate: true,
  // Callback for making requests
  onRequest: onBrowserRequest,
});
```

## GQL 查询

```ts
import { createQuery, createMutation } from "@codesandbox/api";

const sandboxQuery = createQuery("Sandbox", {
  sandbox: [{ sandboxId: "new" }, { isFrozen: true }],
});
```

## 常见问题

### @codesandbox/api 是什么？

密码箱 API

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

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

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

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

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

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

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

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

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

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

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

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