npm 包 @blinkmobile/evergreen-sdk 使用教程

介绍

@blinkmobile/evergreen-sdk 是一款适用于前端的 npm 包,可以帮助开发者轻松实现与 Bluemix Evergreen 服务器通信的功能。Bluemix Evergreen 是 IBM 公司提供的一项云服务,用于为企业级应用程序提供 API 管理和自动化工具,以简化开发工作,并确保更快的时间到市场。

该 npm 包使用 TypeScript 编写,具有良好的可读性和可维护性。

安装

该包可以使用 npm 或 yarn 进行安装:

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

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

快速入门

创建一个 Evergreen 实例

在你的代码中导入 Evergreen,然后创建一个实例。你需要提供你的 Evergreen API 端点 URL,作为创建实例的第一个参数。第二个参数为可选的,用于配置请求。

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

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

发送请求

可以在创建实例后,使用 client.get()client.post()client.put()client.patch()client.delete() 来调用 API。这些方法支持简易的 callback 风格或者是返回 promises。

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

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

处理错误

如果请求失败,返回的错误将简单地包装在一个 EvergreenError 实例中,它扩展了 JavaScript 的原生 Error 对象。

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

高级用法

配置多个请求

默认情况下,@blinkmobile/evergreen-sdk 使用 Node.js 的全局 httphttps 模块来实现请求,这对于大多数用户来说是完全足够的。

但是,对于需要特定配置的用户(例如通过代理连接到 Evergreen、需要 SSL 证书身份验证等等),可以使用自定义的 httphttps 实例将其传递给 Evergreen 构造函数的第三个参数中。

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

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

处理自定义 HTTP 错误

Evergreen 在响应的 HTTP 头部中会包含自定义错误代码。如果你需要对这些代码做特殊处理,可以在请求后的 Promise 或者 callback 中处理。

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

自定义认证

默认情况下,Evergreen 使用 OAuth2 JWT 令牌进行身份验证,如果需要,也可以将自己的认证方式提供给 Evergreen 构造函数的第二个参数上的 headers 对象中。

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

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

结论

@blinkmobile/evergreen-sdk 是一款非常方便的 npm 包,可用于帮助开发者轻松实现与 Bluemix Evergreen 服务器通信的功能。它易于使用,易于阅读和维护,具有灵活的配置和自定义选项。因此,我们鼓励开发者尝试使用该库来加速他们的 Bluemix Evergreen 开发过程。

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


猜你喜欢

  • npm包@blinkmobile/forms-cli使用教程

    在前端开发中,表单是不可避免的部分。而@blinkmobile/forms-cli是一个强大的npm包,可以帮助我们快速创建表单,提高前端开发效率。本篇文章将为您详细介绍该npm包的使用方法。

    3 年前
  • npm 包 @blinkmobile/forms-template-helper 使用教程

    介绍 在前端开发中,表单通常是必不可少的一部分,但表单的样式和结构都比较琐碎,我们很难把他们统一起来。这时,@blinkmobile/forms-template-helper 这个 npm 包就能派...

    3 年前
  • npm 包 @blinkmobile/maybe-run 使用教程

    前言 在前端开发中,我们经常需要运行某些任务,如打包、压缩等。我们通常使用 npm 包来解决这些问题。但是有些情况下,我们需要判断某个命令是否存在再运行它,或者在命令不存在时运行另一个命令。

    3 年前
  • npm 包 ipc-socket 使用教程

    简介 ipc-socket 是一款允许 Node.js 进程间相互通信的 npm 包。它提供了类似于 Socket 的 API,但是在进程间通信时使用了 IPC(Inter-process commu...

    3 年前
  • npm 包 @daniel.husar/on-enter-or-space 使用教程

    在前端开发中,按下回车键或空格键通常会触发一些操作,比如提交表单或者切换焦点。但是这两个键的 keyCode 是不同的,而且不同浏览器之间的 keyCode 也可能不同。

    3 年前
  • npm 包 @blinkmobile/bm-plugin-forms-json 使用教程

    @blinkmobile/bm-plugin-forms-json 是一款方便快捷构建表单的 npm 包,它可以帮助前端开发员快速构建表单界面,并将用户输入的数据以 JSON 格式发送到后端进行处理。

    3 年前
  • npm 包 @blinkmobile/bm-uploader 使用教程

    介绍 npm 是世界上最大的软件包管理系统之一,而 @blinkmobile/bm-uploader 是 npm 上一个实现简单易用的前端上传组件。它可以帮助开发者在前端轻松地实现文件上传功能,也提供...

    3 年前
  • npm包:@blinkmobile/camera 使用教程

    前言 在前端开发中,我们有时需要使用摄像头进行相关操作,比如拍照等。而在JavaScript中,我们可以使用npm包@blinkmobile/camera来实现这些操作。

    3 年前
  • npm 包 node-ledger-client 使用教程

    介绍 node-ledger-client 是一个用于连接 Hyperledger Fabric 的 Node.js 客户端。它支持用户与 Fabric 网络上的链码进行交互,包括查询和执行事务。

    3 年前
  • npm 包 @blinkmobile/canvas-manipulation 使用教程

    介绍 在现代 Web 应用中,Canvas API 是用来绘制和操作图形的一种强大的 HTML5 标准。许多前端开发者使用 Canvas API 来存储和操作图像。

    3 年前
  • npm 包 @jewella/hsl-to-hex 使用教程

    简介 在 Web 开发中,有时我们需要将 HSL(Hue, Saturation, Lightness)颜色格式转换为 HEX(Hexadecimal)格式。npm 上有许多现成的包可以实现这一功能,...

    3 年前
  • npm 包 antfin-sofa-node-antvip 使用教程

    在前端的开发过程中,我们经常需要使用 npm 包来提高我们的开发效率和代码质量。在这篇文章中,我们将会详细介绍 antfin-sofa-node-antvip 这个 npm 包的使用教程,帮助大家更好...

    3 年前
  • npm 包 mysql-mongodb-migrate 使用教程

    随着互联网技术的不断发展,前后端分离架构已成为主流。其中,前端负责 UI 界面、交互逻辑等,后端主要负责数据存储、业务逻辑等。数据存储是许多后端开发者必备的技能,而 mysql-mongodb-mig...

    3 年前
  • npm包 escape-unicode 使用教程

    前置知识 在学习本文之前,需要具备以下知识: Node.js 和 npm 的使用 基本的 JavaScript 知识 背景介绍 在前端开发中,我们经常需要处理 Unicode 字符串。

    3 年前
  • npm 包 nrpl 使用教程

    简介 nrpl 是一个基于 Node.js 实现的简单的日志处理工具,可以将日志输出到标准输出流或者文件流中,同时支持自定义日志级别和输出格式等功能。 其中,nrpl 对于前端开发者来说,是一个非常实...

    3 年前
  • NPM 包 create-accessor 使用教程

    在前端开发中,经常需要对于对象的属性进行读写。直接对属性进行访问虽然方便,但不具备数据合法性检查和副作用控制。而手写 getter 和 setter 又很容易造成代码重复和操作过于繁琐。

    3 年前
  • npm 包 like-to-regexp 使用教程

    在前端开发中,匹配字符串非常重要。而使用正则表达式是一种高效且强大的方式。然而,正则表达式看起来很复杂,学习曲线陡峭,因此,许多开发者在编写正则表达式时遇到了困难。

    3 年前
  • npm 包 @gfi-centre-ouest/docker-compose-spec-typescript 使用教程

    前言 随着时代的发展,前端技术也在不断地发展和进步。其中,npm 包作为前端技术开发的重要组成部分,具有非常重要的作用。而在众多的 npm 包中,@gfi-centre-ouest/docker-co...

    3 年前
  • npm 包 @up24/guid 使用教程

    简介 npm 是 Node.js 的包管理工具,可以通过 npm 快速查找并安装第三方包。@up24/guid 是一个可以生成唯一标识符的 npm 包。在前端开发中,唯一标识符经常被用于指定 DOM ...

    3 年前
  • npm 包 consent-swarm 使用教程

    简介 consent-swarm 是一款基于 P2P 网络的用户数据共享工具。它可以在不泄露用户信息的情况下实现跨平台、跨应用的数据共享和交换,并为用户提供更加个性化的服务。

    3 年前

相关推荐

    暂无文章