npm 包 bs-escrow 使用教程

前言

bs-escrow 是一个基于 Node.js 的小型工具库,使用它可以轻松实现类似支付宝担保交易的功能,即创建并冻结一笔资金,然后在特定的时间内释放资金或将资金支付给指定收款方。本文将详细介绍 bs-escrow 的使用方法及注意事项,希望能对初学者有所帮助。

安装和引入

首先需要在 Node.js 环境下安装 bs-escrow,可以使用 npm 包管理器进行安装,具体操作如下:

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

安装完成后,在项目文件中引入 bs-escrow:

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

API 使用说明

bs-escrow 的 API 参考了支付宝的担保交易 API,其中主要包含三个方法:createEscrowOrderreleaseEscrowOrderpayEscrowOrder

createEscrowOrder 方法

该方法用于创建一笔担保交易,可以指定交易金额、收款方信息和冻结期限等,具体参数及返回值如下:

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

其中,amount 参数表示交易金额,payee 参数表示收款方账户编号,payer 参数表示付款方账户编号,expireTime 参数表示订单在冻结状态的时长,单位为秒。

在创建成功后,该方法将返回一个包含订单号和冻结状态的对象,可以根据需要使用该对象进行后续操作。

releaseEscrowOrder 方法

该方法用于释放一笔担保交易的冻结资金,具体参数及返回值如下:

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

其中,orderId 参数表示交易的订单号,在释放成功后,该方法将返回一个包含成功/失败状态和释放资金的对象。

payEscrowOrder 方法

该方法用于支付一笔担保交易的冻结资金,具体参数及返回值如下:

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

其中,orderId 参数表示交易的订单号,在支付成功后,该方法将返回一个包含成功/失败状态和支付资金的对象。

示例代码

下面是一个简单的示例代码,使用 bs-escrow 创建一笔担保交易,然后先进行支付操作,再进行释放操作:

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

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

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

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

----------

注意事项

在使用 bs-escrow 进行担保交易的过程中,需要注意以下几点:

  1. 必须在 Node.js 环境下使用 bs-escrow。
  2. 传入的账户编号必须预先在系统中存在。
  3. 冻结期限必须在创建交易时单独指定,且单位为秒。
  4. 支付和释放冻结资金时必须传入正确的订单号。

总结

本文介绍了如何使用 bs-escrow 进行担保交易,包含了安装、引入、API 使用以及注意事项等内容。bs-escrow 的使用虽然简单,但这种担保交易模式却在很多交易场景中得到了广泛应用,对于前端开发者来说也具有一定的参考和学习意义。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005533a81e8991b448d07d1


猜你喜欢

  • npm 包 react-dual-range-slider 使用教程

    在前端开发中,经常需要使用到滑块组件来让用户选择一个范围值。其中一款比较好用的滑块组件是 react-dual-range-slider,它可以满足大多数需求。本文将详细介绍如何使用 react-du...

    2 年前
  • npm 包 slash-escape 使用教程

    前端开发中,我们经常需要将字符串中的斜杠进行转义,以便正确地处理路径、URL 或 JSON 等数据。一个常用的库是 slash,它可以将一个反斜杠转成正斜杆,但是它却无法像 escape 一样转义所有...

    2 年前
  • npm 包 paradigm-api 使用教程

    在前端开发中,我们常常需要与后端交互,获取数据并进行处理。为了方便开发、提高效率,许多开发者会选择使用一些常见的工具包,比如 paradigm-api。 在本文中,我们将介绍如何使用 paradigm...

    2 年前
  • npm 包 jord 使用教程

    简介 在前端开发中,我们经常需要操作各种日期时间格式。而 jord 是一个轻量级的 JavaScript 库,可以方便地处理日期时间相关的逻辑。jord 可以解析、验证、格式化和比较日期时间,支持多种...

    2 年前
  • npm 包 zocka-maniaplanet-formatter 使用教程

    前言 在前端开发中,我们经常使用 npm 包来加快我们的开发效率。npm 是一个开放的包管理器,让我们可以轻松地安装、更新和发布包。在本文中,我们将介绍如何使用一个名为 zocka-maniaplan...

    2 年前
  • npm 包 ng2-datepicker2 使用教程

    简介 ng2-datepicker2 是一个 Angular2 的日期选择器组件,它可以用于快速生成基于日期的 UI 元素。该组件由 npm 社区开发并维护,通过 npm 包管理工具可以非常方便地引入...

    2 年前
  • npm 包 simple-object-transformer 使用教程

    在前端开发中,有时我们需要将对象形式的数据进行转换,以便于在不同的场景中使用。而 npm 包 simple-object-transformer 则提供了一种便捷的方法来进行这种转换。

    2 年前
  • npm 包 @whinc/es6-promise 使用教程

    前端开发中,我们经常会碰到异步请求数据的场景,而 ES6 Promise 则是非常常用的解决方案之一。但在某些旧版本浏览器中并不支持该特性,因此我们需要使用第三方包来兼容。

    2 年前
  • npm 包 ember-cli-clappr 使用教程

    前言 在 Web 前端开发中,视频播放一直是一个非常重要的模块。然而,由于浏览器的差异性和兼容性问题,视频播放的实现变得相对困难。不过,现在有一个非常好用的 npm 包 —— ember-cli-cl...

    2 年前
  • 前端开发中使用 gulp-rev-for-sourcemaps

    在前端开发中,我们经常会使用一些构建工具来优化我们的开发流程。其中,gulp-rev-for-sourcemaps 这个 npm 包就是一个十分实用的工具。 gulp-rev-for-sourcema...

    2 年前
  • npm 包 @rohitpal/nuxt 使用教程

    在前端开发中,使用合适的工具包可以大大提高工作效率。@rohitpal/nuxt 是一个基于Vue.js的服务端渲染应用框架,它提供了灵活的目录结构、自动化路由映射、静态文件服务等功能。

    2 年前
  • 前端技术文章:npm 包 sugo-agent-zip 使用教程

    在前端开发中,我们经常会需要进行文件的压缩与解压缩。为此,开发人员们推出了许多优秀的 npm 包,其中 sugo-agent-zip 是一个非常优秀的文件压缩与解压缩的 npm 包。

    2 年前
  • npm 包 steam-tradeoffers-fitcher 使用教程

    在 Steam 社区市场中,Steam 用户可以在其中进行交易。steam-tradeoffers-fitcher 是一个 Node.js 库,它提供 Steam 交易所所需要的各种 API 调用。

    2 年前
  • npm 包 steam-user-fitcher 使用教程

    简介 npm 是一个包管理器,可以帮助开发者轻松地分享和使用代码。steam-user-fitcher 是一个针对 Steam 平台的 Node.js 包,可以帮助开发者实现自动化控制 Steam 账...

    2 年前
  • npm 包 pdfkit-ignore-invalid-fonts 使用教程

    PDF 是我们日常工作中经常会用到的一种文档格式,而 PDFKit 是一个用于 Node.js 和浏览器的 PDF 生成库。然而,在使用 PDFKit 的过程中,有时会出现字体显示不出来的问题,这是因...

    2 年前
  • npm 包 normify 使用教程

    前言 前端开发中,我们经常需要使用多种第三方库和插件来实现特定的功能。其中,npm 是最流行的 JavaScript 包管理器之一。它提供了海量的开源库,可以协助我们快速地开发和部署项目。

    2 年前
  • npm 包 vulcano-cli 使用教程

    前言 随着前端开发的发展,各种工具层出不穷。其中,npm 作为前端最重要的包管理工具之一,为前端开发人员提供了更加高效的开发模式。在 npm 的众多包中,vulcano-cli 是一款非常优秀的命令行...

    2 年前
  • npm 包 icbox-lib 使用教程

    icbox-lib 是一个npm包,它提供了一系列优秀的前端组件和工具函数。这些组件和工具函数可以大大提高我们的工作效率和代码质量。在本文中,我们将会详细介绍icbox-lib的安装和使用方法,并提供...

    2 年前
  • npm 包 @skumtron/minesweeper-engine 使用教程

    介绍 @skumtron/minesweeper-engine 是一个基于 JavaScript 的扫雷游戏引擎,使用该 npm 包可以方便地在你的网页或者应用中实现扫雷游戏。

    2 年前
  • npm 包 jsharmony-ide 使用教程

    在前端开发过程中,我们经常部署和使用各种工具、框架和库来加速我们的开发、提高开发效率和代码质量。在这些工具中,npm 包是我们最为常用和熟悉的一个。今天,我们将着重介绍一个非常值得使用的 npm 包—...

    2 年前

相关推荐

    暂无文章