npm 包 leankit-events 使用教程

阅读时长 4 分钟读完

前言

leankit-events 是一个 npm 包,它为能够访问 LeanKit API 的应用程序和服务提供了一种将事件集成到它们的应用程序管理器的简单方式。本篇文章将介绍如何使用 leankit-events 进行 LeanKit API 的集成。

安装

安装 leankit-events 很简单,只需要在命令行中输入以下命令:

使用

leankit-events 支持 Node.js, Browserify 和 RequireJS,为方便起见,我们以 Node.js 为例进行介绍。

首先,我们需要引入 leankit-events:

然后,我们需要创建一个 leankitEvents 对象,它包含了访问 LeanKit API 时所需的所有信息:

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

其中,auth 中包括 host、email、password 三个属性,分别表示 LeanKit 的主机名、用户邮箱、用户密码。boardId 为 LeanKit 的 board ID,query 表示要获取的信息类型,此处为包括卡片信息、不包括流程变更信息。

接着,我们就可以使用 leankit 对象进行 LeanKit API 的操作了。例如,获取指定卡片的详细信息:

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

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

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

以上代码展示了获取 LeanKit 某个 board 中卡片移动后的详细信息。on 方法表示我们将在事件中监听什么类型的信息,通过 start 方法启动 leankit 对象进行事件监听即可。

示例

下面我们来实现一个简单的例子,监听 LeanKit 上某个 board 中卡片的动态变化,并将变化信息展示在控制台中。假设我们已经安装好了 leankit-events,现在来创建一个新文件:

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

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

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

以上代码展示了如何使用 leankit-events 模块以及如何监听 LeanKit 某个 board 中卡片的移动事件,实现了将卡片的 ID、原始列表和目标列表输出到控制台的操作。

总结

本文介绍了如何安装、使用 npm 包 leankit-events,让我们在 Node.js 环境下轻松访问 LeanKit API 并监听其事件。leankit-events 不仅简便易用,而且功能强大,使得我们可以更方便地开发 LeanKit 相关应用程序和服务。

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

纠错
反馈