npm 包 @shopify/translation-platform-utilities 使用教程

阅读时长 3 分钟读完

背景介绍

在前端开发中多语言处理是很常见的任务,虽然有些人依赖于后端返回不同语言的 html 页面或通过字段从后端传递数据来处理不同语言,但这种方法存在很大的局限性,如果所有的多语言处理都依赖后端的话会给后端的处理带来很大的压力,而前端直接通过 js 处理多语言却显得十分繁琐和不优雅,所以我们需要一个易于操作的多语言处理 npm 包 @shopify/translation-platform-utilities。

功能介绍

@shopify/translation-platform-utilities 可以快速获取 Shopify 的公共多语言信息,也可以将本地多语言文件上传到 Shopify。其中常用的 api 有两种:

1. getTranslations(lang: string): Promise<object>

该方法接收一个参数 lang,用于传入哪种语言的多语言信息。返回一个 Promise object。

示例代码:

-- -------------------- ---- -------
------ ----------------------- ---- ------------------------------------------

----- ----- - --- ------------------------
    ----- ------------------------------
    ------- ------------
    --------- -------------
---

----- -------- --------------------- -
    ----- ------------ - ----- ----------------------------
    --------------------------
-
-------------------------

以上代码的执行结果会打印出具有此语言相关的多语言信息的对象。

2. uploadTranslations(lang: string, translations: object): Promise<void>

该方法尝试将传入的多语言信息上传到 Shopify。如果上传成功,该方法将返回一个 void 的 Promise 对象。

-- -------------------- ---- -------
------ ------------------------ ---- ------------------------------------------

----- ----- - --- ------------------------
    ----- ------------------------------
    ------- ------------
    --------- -------------
---

----- -------- --------------------------- ----- -
    ----- ------------------------------ ------
    ------------------------ ---- -----------
-
------------------------------ -
    ------- -------- --------- -- -------
---

以上代码的执行结果将在 Shopify 上创建或更新 fr-FR 的多语言信息。

注意事项

  1. @shopify/translation-platform-utilities 需要 Shopify 商店的管理员权限
  2. 翻译信息的上传需要审核,一般 24 小时左右,审核完成后才会生效。

结论

通过上述的示例代码,我们可以发现 @shopify/translation-platform-utilities 具有非常强的可用性。只需要简单的配置参数就可以快速获取或上传 Shopify 的多语言信息,大大降低了开发人员的工作量。在此清单系统日益庞大和应用程序复杂的未来,它将成为前端开发中必不可少的一部分。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f3cd9aedbf7be33b25670c6

纠错
反馈