JavaScript SDK

yundict-js 是云词官方团队开源的 JavaScript SDK，用于方便地与云词 API 进行交互。

特性

完整的云词 API 支持
TypeScript 编写，提供完整的类型定义
支持 ES Module
支持 Node.js、Deno、浏览器环境
零依赖

安装

可以通过 NPM/Yarn/CDN 等方式安装 yundict-js。

npm install yundict

初始化

首先你需要在云词控制台「个人设置」->「API Token」获取你的 API Token 用于 API 交互，并将此 Token 传入 Yundict 的构造函数中。

import { Yundict } from "yundict";

const yundict = new Yundict({
  apiToken: "API TOKEN",
});

APIs

团队

用于操作团队相关的 API。

// 获取账户下所有团队
yundict.teams.all();
// 获取某一个团队的详细信息
yundict.teams.get("team-name");
// 创建一个团队
yundict.teams.create({ name: "test-team", displayName: "Test Team" });
// 更新一个团队
yundict.teams.update("test-team", { displayName: "Test Team 2" });
// 删除一个团队
yundict.teams.delete("test-team");

项目

用于操作项目相关的 API，项目是从属于某一个团队的。

// 获取某个团队下所有项目
yundict.projects.all({ team: "my-team" });
// 获取某个团队下某个项目的详细信息
yundict.projects.get({ team: "my-team", project: "project-name" });
// 在某个团队中创建一个新项目
yundict.projects.create({ team: "my-team" }, { name: "test-project", displayName: "Test Project" });
// 在某个团队中更新一个项目
yundict.projects.update(
  { team: "my-team", project: "project-name" },
  { name: "new-project", displayName: "Test Project 2" }
);
// 删除某团队中的一个项目
yundict.projects.delete({ team: "my-team", project: "project-name" });

文案

用于操作文案相关的 API，文案是从属于某一个项目的。

// 查询某个项目下所有文案及其翻译
yundict.keys.all({ team: "my-team", project: "project-name" });
// 查询某个项目下某个文案及其翻译
yundict.keys.create({ team: "my-team", project: "project-name", name: "test-key" });
// 更新某个项目下某个文案或翻译
yun.keys.update({ team: "my-team", project: "project-name", name: "test-key" }, { name: "new-key" });
// 删除某个项目下某个文案
yundict.keys.delete({ team: "my-team", project: "project-name", name: "test-key" });

问题报告

如果你在使用 yundict-js 的过程中遇到任何问题，欢迎在 GitHub Issues 中提出。

贡献代码

如果你想要为 yundict-js 贡献代码，欢迎提交 Pull Request。