# @distr-sh/distr-sdk 中文文档

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

版本：4\.10\.0
npm 元数据更新时间：2026-11-11T10:05:20.108Z
中文译文更新时间：2026-11-12T12:56:34.438Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：74 kB，56 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：26\.x
- 运行依赖：1 个
- 首次发布：2026-01-15T13:36:56.841Z
- 最新版本发布：2026-11-11T10:05:19.765Z
- 近 30 天下载量：2453（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：104（近 12 个月 104 个）

## 中文简介

安全数据

## 安装

```sh
npm install @distr-sh/distr-sdk
```

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

## README

# 安全数据

您可以从 JavaScript 安装 DID SDK [npmjs.org (韩语)](https://npmjs.org/)数字 :

```shell
npm install --save @distr-sh/distr-sdk
```

在概念上,SDK分为两个部分:

-   高级服务 `DistrService`,它为与 Distr API 交互提供了简化接口.
-   一个低级客户端呼叫 `Client`,它为与 Distr API 互动提供了更直接的接口.

为了连接到 Distr API,您必须在 Distr 网络界面中创建个人访问Token(PAT). 可以选择,您可以指定您想要与之沟通的 Distr API 的 URL 。 默认为 `https://app.distr.sh/api/v1`。 。 。 .

```typescript
import {DistrService} from '@distr-sh/distr-sdk';
const service = new DistrService({
  // to use your selfhosted instance, set apiBase: 'https://selfhosted-instance.company/api/v1',
  apiKey: '<your-personal-access-token-here>',
});
// do something with the service
```

这个 [斜弧/实例](https://github.com/distr-sh/distr/tree/main/sdk/js/src/examples) 目录中包含如何使用 SDK 的实例 .

见 [文档](https://github.com/distr-sh/distr/tree/main/sdk/js/docs/README.md) 更多信息.

## 常见问题

### @distr-sh/distr-sdk 是什么？

安全数据

### 如何安装 @distr-sh/distr-sdk？

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

### @distr-sh/distr-sdk 支持 TypeScript 吗？

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

### @distr-sh/distr-sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @distr-sh/distr-sdk 需要什么版本的 Node\.js？

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

### @distr-sh/distr-sdk 可以商用吗？

@distr-sh/distr-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @distr-sh/distr-sdk 的下载量有多少？

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

### @distr-sh/distr-sdk 还在维护吗？

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