编辑器 SDK
TypeScript- first SDK 与 POEditor 本地化平台进行无缝集成
特征
- 类型安全互动 - 严格打字的完整类型脚本支持
- 原子行动 - 批量术语/翻译同步
- 企业准备 - 重试政策、缓存和找回错误
- Webhook 支持 - 内部核查和事件打字
- 高API覆盖率 - 已执行的大多数编辑端点
安装
# Using yarn
yarn add @dbbs/poeditor-sdk
# Using npm
npm install @dbbs/poeditor-sdk
快速启动 QQ
-
获取 API 托肯
访问 POEditor 账户设置
生成 API 令牌
安全存储( 建议: 环境变量)
-
基本用途
import { POEditorSDK } from '@dbbs/poeditor-sdk';
// Initialize with project ID and token
const sdk = new POEditorSDK(process.env.POEDITOR_TOKEN, 12345);
// Sync terms atomically
await sdk.syncTerms({
terms: [
{ term: 'welcome_message', context: 'greetings' },
{ term: 'error_404', context: 'errors' }
]
});
// Export French translations
const frenchTranslations = await sdk.exportProject({
language: 'fr',
type: 'json'
});
API 参考QQ
| 类别 | 方法 | 参数 | 说明 |
|---|---|---|---|
| 项目 | listProjects() | - 说吧 | 列出所有可访问的项目 |
| 项目 | exportProject() | { language: string, type: Format } | 导出翻译 |
| 术语 | syncTerms() | { terms: Term[] } | 原子术语同步 |
| 术语 | updateTerms() | { terms: UpdateTerm[] } | 批量术语更新 |
| 语文 | addLanguageToProject() | { language: string, code?: string } | 添加新工程语言 |
捐款额
我们欢迎捐款! 请遵循我们的工作流程:
-
叉子存储器
-
创建特征分支( feat/ your- setature)
-
新功能的写入测试
-
以 :
- Description of changes - Updated documentation - Test coverage report
许可证 QQ
DBBS Poeditor SDK是开源软件,根据 MIT 许可证。 。 。 .