@node-red/runtime.flows

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

添加流配置

参数
名称 类型 描述
选项 对象
名称 类型 描述
用户 用户

调用API的用户

对象

要添加的流

请求 对象

要记录的请求(可选)

返回
类型
Promise.<String>
  • 添加的流的 ID

deleteFlow(opts) → {Promise}

删除流

参数
名称 类型 描述
选项 对象
名称 类型 描述
用户 用户

调用API的用户

ID 对象

要删除的流的 ID

请求 对象

要记录的请求(可选)

返回
类型
Promise
  • 如果成功则解析

getFlow(opts) → {Promise.<Flow>}

获取单个流配置

参数
名称 类型 描述
选项 对象
名称 类型 描述
用户 用户

调用API的用户

ID 对象

要检索的流的 ID

请求 对象

要记录的请求(可选)

返回
类型
Promise.<Flow>
  • 活动的流配置

getFlows(opts) → {Promise.<Flows>}

获取当前流配置

参数
名称 类型 描述
选项 对象
名称 类型 描述
用户 用户

调用API的用户

请求 对象

要记录的请求(可选)

返回
类型
Promise.<Flows>
  • 活动的流配置

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

获取节点的安全凭据

参数
名称 类型 描述
选项 对象
名称 类型 描述
用户 用户

调用API的用户

类型 字符串

要返回凭据信息的节点类型

ID 字符串

节点 ID

请求 对象

要记录的请求(可选)

返回
类型
Promise.<Object>
  • 安全凭据

setFlows(opts) → {Promise.<Flows>}

设置当前流配置

参数
名称 类型 描述
选项 对象
名称 类型 描述
用户 用户

调用API的用户

流程 对象

流配置:{flows: [..], credentials: {}}

部署类型 对象

部署类型 - “full”、“nodes”、“flows”、“reload”

请求 对象

要记录的请求(可选)

返回
类型
Promise.<Flows>
  • 活动的流配置

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

更新现有流配置

参数
名称 类型 描述
选项 对象
名称 类型 描述
用户 用户

调用API的用户

ID 对象

要更新的流的 ID

对象

流配置

请求 对象

要记录的请求(可选)

返回
类型
Promise.<String>
  • 更新后的流的 ID