npm 包 alfred-dasher 使用教程

阅读时长 6 分钟读完

alfred-dasher 是一款基于 Node.js 平台的开发工具,能够快速搭建并且自定义良好的 Alfred 工具栏。如果你对 Node.js 和 Alfred workflow 有基本的了解,你可以用 alfred-dasher 更加便捷地创建 workflows。在本篇文章中,我们将探究如何使用 alfred-dasher 进行快速的 Alfred workflow 开发,并且介绍其常用的 API,让你可以及时地创建你所需要的 workflow。

安装 alfred-dasher

安装 alfred-dasher 十分简单。在你的项目中,打开终端并输入以下命令:

创建 workflow

在文件夹中,创建一个名为 index.js 的新文件,输入以下代码:

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

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

上面这段代码创建了一个 workflow,并且可以通过以下关键字来访问它:keyword1keyword2keyword3。除了这些关键字,还需要输入一个参数。同时,在执行完毕之后,输出的结果格式如 {output}

Workflow API

在下列代码片段中,我们将介绍在上面所创建的 workflow 中使用到的常用 API:

keywords

该 API 用于定义你的 workflow 可以使用的关键字。你需要通过一个数组,将这些关键字传递进去。例如:

inputFormat

该 API 用于定义接受的输入格式。你可以在其中定义你的 workflow 将接受的参数和关键字。例如,如下所示的代码定义了,workflow 接受的参数名称为 input:

outputFormat

在这个 API 中,可以定义输出的格式,让 workflow 更加灵活和可定制。在这里,你可以定义输出字段,比如 titlesubtitlearg 等等。例如:

action

action API 是定义 workflow 的主要 API。在这里,可以定义 workflow 的行为:执行有关请求、提交数据等等操作。下列代码将使用 action 定义 workflow 行为:

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

示例

下列代码示例展示了如何使用 Alfred workflow 搜索 Google 搜索结果:

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

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

在这个示例中,我们定义了一个名为 google 的关键字,可以通过它来访问 workflow。同时,将搜索文本 query 作为参数进行处理。 workflow 将执行一个异步方法,该方法将搜索结果返回到 Alfred 之中。 Alfred 然后可以显示标题、子标题和它们之间的链接。同时, Alfred 可以使用 arg 参数打开搜索结果所代表的网页。

结论

在本篇文章中,我们展示了如何使用 alfred-dasher 创建自定义的 workflow。我们介绍了安装和创建 workflow 的基本步骤,还讨论了 workflow 开发的常见 API。同时,我们提供了基础的示例,让你能够更好地理解 workflow 的工作原理,并且得到快速实践的机会。下次你需要创建一个新的 workflow 的时候,不妨尝试使用 alfred-dasher,它会让你开发一个完美的 workflow 更加便捷和灵活。

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

纠错
反馈