简介
stellar-qr 是一个用于生成Stellar支付地址二维码的 npm 包。它是一个轻量级库,通过使用 QR 码生成器 qrcode 库,能够快速而简单地创建 Stellar 支付地址的二维码。
安装
要使用 stellar-qr 库,请先在终端中进入项目的根目录,然后使用以下命令安装:
npm i stellar-qr --save
快速开始
使用 stellar-qr 库很容易,只需要几行代码即可。
-- -------------------- ---- ------- ----- --------- - ---------------------- -- ---- ------- ----- ----- ------ - --- ----------- -------- ----------------------------------------------------------- ------- -------- ---------- ----- --- -- -- --- -------- ----------------------------
当您运行这些代码时,会在终端中看到生成的 Stellar 支付地址的二维码的 SVG 格式的数据。
参数
构造 StellarQR 对象时,可以传入以下参数:
address
(必需):要收款的 Stellar 支付地址amount
(可选):要发送的资产数量。此参数应该以字符串格式表示,精确到小数点后七位,最大为 "9223372036854.7758079" XLM。memo
(可选):用于附加到付款中的备注数据的 1 到 28 字符字符串。建议使用一个32个字节的字符串,以确保到达Memo。memoType
(可选):将其设置为“hash”将通过使用 shadown 执行哈希处理。 如果将其设置为“text”,则将其解释为纯文本。 如果留空,将假定为纯文本。assetIssuer
(可选):代币发行人的公共密钥,用于指定付款资产。 如果要指定 XLM 作为要发送的资产,请不要使用此参数。assetCode
(可选):该资产的代号。 如果要指定 XLM 作为要发送的资产,请不要使用此参数。
高级用法
以下是一些高级用法示例:
生成 PNG 格式的二维码
如果要生成 PNG 格式的二维码,请使用以下代码:
-- -------------------- ---- ------- -- ---- ------- ----- ----- ------ - --- ----------- -------- ----------------------------------------------------------- ------- -------- ---------- ----- --- -- - --- ---------- ---------------------------- ------ ----- -- - -- ----- ----- ---- ---------------- --- ------- -------------- ---
自定义二维码的大小和颜色
使用以下代码可自定义二维码的大小和颜色:
-- -------------------- ---- ------- -- ---- ------- ----- ----- ------ - --- ----------- -------- ----------------------------------------------------------- ------- -------- ---------- ----- --- -- ------- --------------------- -- ---------- ----------------------------------------- -- ---------- ----------------------------------- -- -- --- -------- ----------------------------
这些代码将生成一个更大、带有白色背景和黑色前景的二维码。
结论
stellar-qr 是一个简单而功能强大的 npm 包,用于生成 Stellar 支付地址的二维码。它易于使用和安装,并提供了许多可定制的选项。希望这篇文章对您学习和使用 stellar-qr 有所助益。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600572c681e8991b448e8ea2