@codesandbox/api

中文文档
1.1.3发布于 2025/01/30MITTypeScriptESM + CJS近 30 天下载 2.2万

密码箱 API

中文使用文档
文档目录3 节
  1. 还需要做的事
  2. 开始吧
  3. GQL 查询

@ codesandbox/ api (帮助)

还需要做的事

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

开始吧

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 查询

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

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

版本与发布记录

@codesandbox/api 共发布 3 个版本,首次发布于 2024/12/12;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.3latest2025/01/301.8 年前
1.1.12025/01/251.8 年前
0.1.02024/12/121.9 年前

关于 @codesandbox/api 的常见问题

@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 和提交记录判断。