介绍
rocketchat-commandwords 是一个 Node.js 模块，它允许用户在 Rocket.Chat 中创建自定义命令，并在聊天中使用这些命令。这个模块的主要特点是它可以让你创建你自己的关键字，这些关键字可以被用来调用你的自定义命令。
本文将介绍 rocketchat-commandwords 的用法，并提供实例代码以及详细的指导意义。
安装
使用 npm 安装 rocketchat-commandwords：
$ npm install rocketchat-commandwords
使用方法
要使用 rocketchat-commandwords，你需要首先创建一个命令词典（command dictionary）。命令词典是一个对象，它有两个属性：commands 和 keywords。其中 commands 是一个数组，包含所有你要创建的自定义命令的信息，而 keywords 是一个数组，包含所有你要创建的关键字的信息。
创建完命令词典之后，你可以使用 rocketchat-commandwords 将其注册到 Rocket.Chat 中。注册完成后，你可以在聊天中使用你所定义的命令，并通过关键字来调用它们。
创建命令词典
下面是一个简单的命令词典示例：
-- -------------------- ---- -------
----- ---------- - -
--------- -
-
----- --------
------------ ---- ----- -- -----------
-------- -- -- -
------------------- -------------
-
--
-
----- -------
------------ ----- - ------
-------- -- -- -
----- ------ - ------------------------ - -- - --
---------------- ------ - -------------
-
-
--
--------- -
-
-------- -----
-------- -------
--
-
-------- -------
-------- ------
-
-
--在这个示例中，我们定义了两个命令：hello 和 roll，以及两个关键字：hi 和 dice。当用户输入 hi 时，会自动调用 hello 命令，同时当用户输入 dice 时，会自动调用 roll 命令。
注册命令词典
当你创建完命令词典之后，你需要将其注册到 Rocket.Chat。rocketchat-commandwords 提供了一个 register 函数，帮助你完成注册：
-- -------------------- ---- ------- ----- ---------- - -------------------------- ----- ------------ - ----------------------------------- ----- -- - ------------ ---- ----------------------- --------- -------------------------------- --------- ------------------------------- --- ----- ---------- - - -- ---- ---------- ------ ---- -- ----- -- - --- ---------------- ------------ --------------------- -- - ------------------------- ------------- ---
在这个示例中，我们利用 rocketchat-bot 创建了一个 Rocket.Chat 的连接，并传递到 CommandWords 的构造函数中。然后，我们创建了一个命令词典 dictionary，并将其传递到 CommandWords 的构造函数中。最后，我们调用了 register 函数来注册命令词典。
使用命令
现在你已经完成了 rocketchat-commandwords 的注册，你可以在 Rocket.Chat 中使用你所自定义的命令了。例如，在聊天中输入 hi，你将会看到一条回复：Hello, everybody!。如果你输入 dice，你将会看到一个随机数的结果。
命令词典属性
在命令词典中，每个命令都应该具有以下属性：
name- 命令的名称。名称应该是唯一的，并且不应该包含任何空格。description- 命令的描述信息。execute- 命令的执行函数。
每个关键字都应该具有以下属性：
keyword- 关键字的名称。名称应该是唯一的，并且不应该包含任何空格。command- 所对应命令的名称。
总结
rocketchat-commandwords 是一个非常方便的 Node.js 模块，可以帮助你在 Rocket.Chat 中创建自定义命令，并在聊天中使用这些命令，同时它还提供了自定义关键字的功能。在本文中，我们介绍了 rocketchat-commandwords 的使用方法，并提供了示例代码和详细的指导意义。希望本文能够帮助你更好地理解 rocketchat-commandwords，并在你的项目中应用它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005684c81e8991b448e4578