衍生工具库(@deriv/utils)
概览
这个公用图书馆提供一套全面的公用设施,旨在支持开发Deriv的网络应用程序。 它囊括了诸如处理常数、格式化、排序等共同功能,并侧重于提高开发效率和确保类型安全.
这个库分为两个主要的命名空间:
- 常数
AppIDConstants:持有与不同域的应用ID相关的常数,为基于域的应用ID管理提供方便.CurrencyConstants: 假设由衍生工具支持的所有货币,简化与货币有关的业务.LocalStorageConstants: 一份详尽的Deriv网络应用全程使用的所有本地存储密钥列表,确保本地存储访问的一致性.
- 用户
FormatUtils:包含用于字符串格式化的效用函数,包括数字格式化,货币符号分辨率等.LocalStorageUtils: 提供一种围绕浏览器本地Storage功能的类型安全包装,增强可靠性并方便使用.ObjectUtils: 用于操纵物体的提供功能,例如深层合并,克隆,以及地产取出等.PromiseUtils: 包括处理承诺的公用事业,如超时包装和承诺链式帮助.URLUtils:包含用于操纵URL的功能,包括参数提取,URL构建,和查询字符串操纵等.WebSocketUtils: 封装Deriv WebSocket特有的公用设备,处理环境检测,登录ID检索,以及应用ID管理.CountryUtils:用于检索和管理客户端国家和相关数据的工具.
开始
只需从 @deriv-com/utils 软件包中安装衍生的 utils 即可启动
npm i --save @deriv-com/utils
或者说
yarn add @deriv-com/utils
用法示例
上面列出的每个命名空间都直接从库根被曝光. 在这个例子中,我们正在使用 FormatUtils.formatMoney() 功能,将不同货币格式化为正确的小数点或本地化格式.
import { FormatUtils } from "@deriv-com/utils";
const formattedBalance = FormatUtils.formatMoney(1, { currency: "BTC" });
console.log(formattedBalance); // Should output 1.00000000
文档
关于每个工具与常数的详细文档,请参考常数和使用目录中的具体文件. 每个功能和常数都用JSDoc的评论记录下来,提供对其目的、参数和返回值的见解。 (一个专用文件页正在准备之中)
捐款
我们欢迎各方为会议提供捐款 @deriv-com/utils 图书馆。 如果您有改进建议或找到错误, 请打开一个问题或提交拉动请求 .
页:1
@deriv-com/utils输出ESM和CJS文件,但目前这个库只支持在浏览器环境中运行的代码. 然而,正在规划对节点运行时间的支持.