Node-RED 中文

addModule(opts) → {Promise.<ModuleInfo>}

在运行时中安装新模块

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`模块`	`字符串`	要安装的模块ID
`版本`	`字符串`	（可选）要安装的模块版本
`tarball`	`对象`	（可选）要安装的 tarball 文件。对象具有 `name`、`size` 和 `buffer` 属性。
`url`	`字符串`	（可选）要安装的URL
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<ModuleInfo>

节点模块信息

getIcon(opts) → {Promise.<Buffer>}

获取节点图标

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`模块`	`字符串`	请求图标的模块 ID
`icon`	`字符串`	图标名称
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Buffer>

图标文件作为 Buffer，如果无可用图标则为 null

getIconList(opts) → {Promise.<IconList>}

获取运行时中所有已安装模块的可用图标列表

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<IconList>

所有图标列表

getModuleCatalog(opts) → {Promise.<Object>}

获取模块的消息目录

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`模块`	`用户`	模块
`lang`	`用户`	要返回的 i18n 语言。如果未设置，则使用运行时默认值 (en-US)
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

getModuleCatalogs(opts) → {Promise.<Object>}

获取所有注册的模块消息目录

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`lang`	`用户`	要返回的 i18n 语言。如果未设置，则使用运行时默认值 (en-US)
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Object>

getModuleInfo(opts) → {Promise.<ModuleInfo>}

获取节点模块的信息

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`模块`	`字符串`	要返回的模块ID
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<ModuleInfo>

节点模块信息

getModuleResource(opts) → {Promise.<Buffer>}

从模块获取资源

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`模块`	`字符串`	请求资源的模块 ID
`path`	`字符串`	资源的路径
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<Buffer>

资源文件作为 Buffer，如果未找到则为 null

getNodeConfig(opts) → {Promise.<String>}

获取单个节点的 HTML 内容

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要返回的节点集的 ID
`lang`	`字符串`	要返回的区域语言
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<String>

节点 HTML 内容

getNodeConfigs(opts) → {Promise.<String>}

获取所有节点的 HTML 内容

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`lang`	`字符串`	要返回的区域语言
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<String>

节点 HTML 内容

getNodeInfo(opts) → {Promise.<NodeInfo>}

获取单个节点集的信息

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要返回的节点集的 ID
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<NodeInfo>

节点信息

getNodeList(opts) → {Promise.<NodeList>}

获取运行时中安装的节点模块列表

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<NodeList>

节点模块列表

removeModule(opts) → {Promise}

从运行时中移除模块

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`模块`	`字符串`	要移除的模块 ID
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise

完成时解析

setModuleState(opts) → {Promise.<ModuleInfo>}

在运行时中启用或禁用模块

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`模块`	`字符串`	要启用或禁用的模块 ID
`已启用`	`字符串`	模块应启用或禁用
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<ModuleInfo>

模块信息对象

setNodeSetState(opts) → {Promise.<ModuleInfo>}

在运行时中启用或禁用单个节点集

参数

名称类型描述

opts

对象

名称	类型	描述
`用户`	`用户`	调用API的用户
`id`	`字符串`	要启用或禁用的节点集 ID
`已启用`	`字符串`	模块应启用或禁用
`req`	`对象`	要记录的请求（可选）

返回

类型: Promise.<ModuleInfo>

模块信息对象

函数

addModule(opts) → {Promise.<ModuleInfo>}

参数

返回

getIcon(opts) → {Promise.<Buffer>}

参数

返回

getIconList(opts) → {Promise.<IconList>}

参数

返回

getModuleCatalog(opts) → {Promise.<Object>}

参数

返回

getModuleCatalogs(opts) → {Promise.<Object>}

参数

返回

getModuleInfo(opts) → {Promise.<ModuleInfo>}

参数

返回

getModuleResource(opts) → {Promise.<Buffer>}

参数

返回

getNodeConfig(opts) → {Promise.<String>}

参数

返回

getNodeConfigs(opts) → {Promise.<String>}

参数

返回

getNodeInfo(opts) → {Promise.<NodeInfo>}

参数

返回

getNodeList(opts) → {Promise.<NodeList>}

参数

返回

removeModule(opts) → {Promise}

参数

返回

setModuleState(opts) → {Promise.<ModuleInfo>}

参数

返回

setNodeSetState(opts) → {Promise.<ModuleInfo>}

参数

返回