# @builder\.io/sdk 中文文档

规范地址：https://npmcn.com/package/%40builder.io/sdk/

版本：6\.3\.4
npm 元数据更新时间：2026-11-05T12:13:30.457Z
中文译文更新时间：2026-11-08T19:00:36.455Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.9 MB，109 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2018-02-01T18:02:41.542Z
- 最新版本发布：2026-11-05T12:13:30.025Z
- 近 30 天下载量：408275（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：717（近 12 个月 7 个）

## 中文简介

这个SDK基本上是我们的包 [内容 API](https://www.builder.io/c/docs/content-api)

## 安装

```sh
npm install @builder.io/sdk
```

也可以使用：`pnpm add @builder.io/sdk`、`yarn add @builder.io/sdk`、`bun add @builder.io/sdk`

## README

# 构建器 Core SDK

这个SDK基本上是我们的包 [内容 API](https://www.builder.io/c/docs/content-api)

```javascript
import { builder } from '@builder.io/sdk';

builder.init(YOUR_KEY);

// Optional custom targeting
builder.setUserAttributes({
  userIsLoggedIn: true,
  whateverKey: 'whatever value',
});

builder
  .get(YOUR_MODEL_NAME, {
    // Optional custom query
    query: {
      'data.customField.$gt': 100,
    },
  })
  .promise()
  .then(({ data }) => {
    // Do something with the data
  });

// The options that you can send to builder.get and builder.getAll
// are defined here: https://forum.builder.io/t/what-are-the-options-for-the-methods-builder-get-and-builder-getall/1036
builder
  .getAll(YOUR_MODEL_NAME, {
    limit: 10,
  })
  .then(results => {
    // Do something with the results
  });

// Turn of cookies/tracking
builder.canTrack = false;
```

查看所有选项 `builder.get` [这里](https://npmcn.com/package/%40builder.io/sdk/docs/interfaces/GetContentOptions.md)

更多地了解如何使用构建器核心SDK:

-   [内容 API](https://www.builder.io/c/docs/content-api)
-   [查询出价表](https://www.builder.io/c/docs/querying)

## 常见问题

### @builder\.io/sdk 是什么？

这个SDK基本上是我们的包 内容 API

### 如何安装 @builder\.io/sdk？

在项目目录运行 npm install @builder\.io/sdk，或使用 pnpm add / yarn add / bun add。

### @builder\.io/sdk 支持 TypeScript 吗？

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

### @builder\.io/sdk 支持 ESM 还是 CommonJS？

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

### @builder\.io/sdk 可以商用吗？

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

### @builder\.io/sdk 的下载量有多少？

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

### @builder\.io/sdk 还在维护吗？

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