first commit
使用前请先确定已了解 Starling 产品的相关功能,已注册并加入到某个项目中,下文均以此为前提。
npm install @volcengine/i18n-node
获取当前待拉取文案的所在项目名称、空间名称和项目的appKey,使用如下接口创建客户端:
appKey
const Client = require('@volcengine/i18n-node'); const client = new Client("projectName", "namespace", "appKey");
项目名、空间名称、appKey 从 Starling 平台获取,请保证正确,appKey 用于身份鉴权,为安全考虑建议不要使用明文出现在代码中。
提供两种方式获取已翻译的文案:获取给定项目、给定空间的整个文案包 或者 指定获取单个key的文案。
通过指定key和语言,以及可选的模式(如灰度发布的文案,功能暂未支持,可先忽略),对于语言可指定兜底语言或者指定版本。具体接口定义如下:
const text = await client.getText("locale", "key");
通过指定语言以及可选的模式(如灰度发布的文案,功能暂未支持,可先忽略)获取整个文案包,对于语言可指定兜底语言或者指定版本。文案包以 key=value 对的形式返回,具体接口定义如下:
key=value
const result = await client.getPackage("locale");
版权所有:中国计算机学会技术支持:开源发展技术委员会 京ICP备13000930号-9 京公网安备 11010802032778号
Node SDK
使用前请先确定已了解 Starling 产品的相关功能,已注册并加入到某个项目中,下文均以此为前提。
安装
创建客户端
获取当前待拉取文案的所在项目名称、空间名称和项目的
appKey,使用如下接口创建客户端:项目名、空间名称、
appKey从 Starling 平台获取,请保证正确,appKey用于身份鉴权,为安全考虑建议不要使用明文出现在代码中。获取文案
提供两种方式获取已翻译的文案:获取给定项目、给定空间的整个文案包 或者 指定获取单个key的文案。
获取单个文案
通过指定key和语言,以及可选的模式(如灰度发布的文案,功能暂未支持,可先忽略),对于语言可指定兜底语言或者指定版本。具体接口定义如下:
获取文案包
通过指定语言以及可选的模式(如灰度发布的文案,功能暂未支持,可先忽略)获取整个文案包,对于语言可指定兜底语言或者指定版本。文案包以
key=value对的形式返回,具体接口定义如下: