# @devrev/typescript-sdk 中文文档

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

版本：1\.1\.79
npm 元数据更新时间：2026-10-09T21:16:28.624Z
中文译文更新时间：2026-11-12T04:06:05.113Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：3.2 MB，53 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2023-04-28T18:42:00.662Z
- 最新版本发布：2026-10-09T21:16:28.425Z
- 近 30 天下载量：17899（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：79（近 12 个月 9 个）

## 中文简介

## SDK 生成

## 安装

```sh
npm install @devrev/typescript-sdk
```

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

## README

# 授权

设置嵌入变量 `DEVREV_TOKEN` 默认情况下,它将作为认证符, 您也可以通过 url 和 order in `client.setup()` (a) 将第1款改为第1款。 它还必须进行测试.

# 安装

```
npm install @devrev/typescript-sdk
```

该版本可见于 package.json. SDK目前为β. 确保您的项目 **软件包.json** 包含 `"type":"module"` 设置.

# Beta SDK 实例使用

```
import {client, betaSDK} from "@devrev/typescript-sdk";

const devrevBetaSDK = client.setupBeta({ endpoint: "https://api.devrev.ai",
token: process.env.DEVREV_TOKEN });

async function test(){
    const response = await devrevBetaSDK.worksCreate({title:"New work item!",
    applies_to_part: "PROD-1",
    owned_by:["DEVU-1"],
    type: betaSDK.WorkType.Issue})
    console.log(response)
}

test()

```

# 公共 SDK 示例使用

```
import {client, publicSDK} from "@devrev/typescript-sdk";

const devrevSDK = client.setup({ endpoint: "https://api.devrev.ai", token: process.env.DEVREV_TOKEN });

async function test(){
    const response = await devrevSDK.worksCreate({title:"New work item!", applies_to_part: "PROD-1", owned_by:["DEVU-16"], type: publicSDK.WorkType.Issue})
    console.log(response.status)
}

test()
```

# 执行 Repo 中的测试

```
npm test
```

# Devrev SDK Utils 指南 维基百科中的相关条目: 克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克

## 基本设置

首先,以您的 DevRev 证书初始化 SDK :

```typescript
import { client } from '@devrev/typescript-sdk';
import { BetaSdkUtil } from '@devrev/sdk-utils';

// Initialize the DevRev SDK
const devrevSDK = new client.setupBeta({
  // Your DevRev credentials
  endpoint: "https://api.devrev.ai",
  token: "YOUR_TOKEN"
});

// Initialize the utils SDK
const sdkUtil = new BetaSdkUtil(devrevSDK);
```

## 核心特征

### 1\. 用户管理

获取账户中所有 Rev 用户 :

```typescript
const accountId = "ACC-12345";
const revUsers = await sdkUtil.getAllRevUsersFromAccount(accountId);
// Returns array of RevUser objects
```

### 2\. 文件管理

#### 上传文件

```typescript
import { FileTypes } from '@devrev/sdk-utils';

// Prepare file object
const fileObject = {
  file_name: "example.txt",
  file_type: FileTypes.OTHERS,
  file: Buffer.from("Hello World"),
  custom_file_type: "text/plain" // Required when file_type is OTHERS
};

// Upload file
const artifactId = await sdkUtil.uploadFileToArtifact(fileObject);
```

#### 获取文件内容

```typescript
const artifactId = "ART-12345";
const fileContent = await sdkUtil.getFileContentFromArtifact(artifactId);
```

## 处理错误

SDK包括内置 `API` 提供详细错误信息的错误处理 :

```typescript
try {
  await sdkUtil.uploadFileToArtifact(fileObject);
} catch (error) {
  // Error will be automatically handled with detailed logging:
  // === Error Details ===
  // Service: [function name]
  // API: [API endpoint]
  // Error Type: [error type]
  // Status Code: [status code]
  // Message: [error message]
}
```

## 类型脚本支持

SDK是用 TypeScript 书写的,为下列类型提供了全面的类型定义:

-   文件管理操作
-   用户管理
-   API 处理错误

## 如何贡献?

1.  **创建新分支**
    
    -   首先为您的特性或错误修正创建单独的分支 .
2.  **遵循最佳编码做法**
    
    -   确保您的代码遵守以下准则:
        -   使用 `try-catch` 块.
        -   使用SDK的TypeScript类型/界面来进行类型安全.
        -   上传前检查文件类型要求 .
        -   使用内置的 API 错误处理来进行一致的日志 .
3.  **增强 `BetaSDKUtil`**
    
    -   修改 `BetaSDKUtil` 增加新的公用事业.
    -   编写综合测试案例以确保功能.
4.  **运行测试**
    
    -   使用 :
        
        ```
        npm test
        ```
        
5.  **提交拉动请求**
    
    -   打开一个拉取请求,并清晰而详细地描述您的变化.

## 常见问题

### @devrev/typescript-sdk 是什么？

SDK 生成

### 如何安装 @devrev/typescript-sdk？

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

### @devrev/typescript-sdk 支持 TypeScript 吗？

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

### @devrev/typescript-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @devrev/typescript-sdk 可以商用吗？

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

### @devrev/typescript-sdk 的下载量有多少？

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

### @devrev/typescript-sdk 还在维护吗？

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