Node-RED 中文

addModule(module) → {Promise.<Object>}

将新模块加载到注册表中。

这将重新扫描节点模块路径以查找此模块。

参数

名称	类型	描述
`模块`	`字符串`	要添加的模块的名称

抛出

如果模块已添加或运行时设置不可用

返回

类型: Promise.<Object>

一旦模块添加完成，将解析为模块信息的 Promise

cleanModuleList()

根据实际加载的模块更新内部可用模块列表。

externalModules.autoInstall（以前是autoInstallModules）运行时选项表示运行时可能在初始加载完成后尝试安装缺失的模块。如果未设置该标志，则此函数用于从注册表的保存列表中移除模块。

disableNode(type) → {Promise}

禁用节点集，使其不可用。

参数

名称	类型	描述
`类型`	`字符串`	节点类型或集标识符

抛出

如果标识符无法识别或运行时设置不可用

返回

类型: Promise

节点集禁用时解析的 Promise

enableNode(type) → {Promise}

启用节点集，使其可用。

参数

名称	类型	描述
`类型`	`字符串`	节点类型或集标识符

抛出

如果标识符无法识别或运行时设置不可用

返回

类型: Promise

节点集启用时解析的 Promise

get(type) → {function}

获取节点构造函数。

参数

名称	类型	描述
`类型`	`字符串`	节点类型

返回

类型: 函数

节点构造函数

getModuleInfo(type) → {Object}

获取模块信息。

参数

名称	类型	描述
`类型`	`字符串`	模块标识符

返回

类型: 对象

模块信息

getModuleList() → {Object}

获取注册表中所有模块的列表。

返回

类型: 对象

模块列表

getModuleResource(module, path) → {String}

获取模块资源文件的完整路径

参数

名称	类型	描述
`模块`	`字符串`	提供资源文件的模块名称
`路径`	`字符串`	资源文件的相对路径

返回

类型: 字符串

资源文件的完整路径

getNodeConfig(id, lang) → {String}

获取单个节点集的 HTML 配置。

参数

名称	类型	描述
`id`	`字符串`	节点标识符
`lang`	`字符串`	要返回的语言，默认为 `en-US`

返回

类型: 字符串

节点配置

getNodeConfigs(lang) → {String}

获取注册表中所有节点的 HTML 配置。

参数

名称	类型	描述
`lang`	`字符串`	要返回的语言，默认为 `en-US`

返回

类型: 字符串

节点配置

getNodeExampleFlowPath(module, path) → {String}

获取节点示例的完整路径

参数

名称	类型	描述
`模块`	`字符串`	提供示例的模块名称
`路径`	`字符串`	示例的相对路径

返回

类型: 字符串

示例的完整路径

getNodeExampleFlows() → {Object}

获取注册表中节点提供的所有示例流程的列表。

返回

类型: 对象

一个对象，按模块索引，列出所有示例流程

getNodeIconPath(module, icon) → {String}

获取节点图标文件的本地路径。

参数

名称	类型	描述
`模块`	`字符串`	提供图标的模块
`icon`	`字符串`	图标名称

返回

类型: 字符串

图标的本地路径

getNodeIcons() → {String}

获取所有可用图标的完整列表。

返回

类型: 字符串

图标列表

getNodeInfo(type) → {Object}

获取节点集信息。

参数

名称	类型	描述
`类型`	`字符串`	节点类型或集标识符

返回

类型: 对象

节点集信息

getNodeList() → {Object}

获取注册表中所有节点的列表。

返回

类型: 对象

节点列表

init(runtime)

使用运行时对象的引用初始化注册表

参数

名称	类型	描述
`运行时`	`对象`	一个运行时对象

installerEnabled() → {Boolean}

检查注册表是否能够安装/移除模块。

这取决于它是否在命令行上找到了 npm。

返回

类型: 布尔值

安装程序是否启用

installModule(module, version, url) → {Promise.<Array>}

使用 npm 安装新的节点模块，然后添加到注册表

参数

名称	类型	描述
`模块`	`String` \| `Buffer`	要安装的模块名称，或包含模块 tar 文件的 Buffer
`版本`	`字符串`	要安装的模块版本，默认为：`latest`
`url`	`字符串`	（可选）安装模块的 URL

返回

类型: Promise.<Array>

一旦模块安装完成，将解析为模块信息的 Promise

load() → {Promise}

触发所有 Node-RED 节点模块的初始发现和加载。在节点路径上找到。

返回

类型: Promise

当注册表完成发现节点模块时解析。

registerType(nodeSet, type, constructor)

注册节点构造函数。

参数

名称	类型	描述
`nodeSet`	`对象`	构造函数所属的节点集对象
`类型`	`字符串`	节点类型
`constructor`	`函数`	节点构造函数

removeModule(module) → {Promise.<Array>}

从注册表中移除模块。

参数

名称	类型	描述
`模块`	`字符串`	要移除的模块名称

抛出

如果未找到模块或运行时设置不可用

返回

类型: Promise.<Array>

解析为已移除节点集列表的 Promise

uninstallModule(module) → {Promise.<Array>}

使用 npm 卸载模块

参数

名称	类型	描述
`模块`	`字符串`	要卸载的模块名称

返回

类型: Promise.<Array>

模块移除时解析的 Promise