存储 API

存储插件是一个 node.js 模块,它在其 module.exports 上暴露以下功能。

函数 描述
Storage.init(settings) 初始化存储系统
Storage.getFlows() 获取流程配置
Storage.saveFlows(flows) 保存流程配置
Storage.getCredentials() 获取流程凭证
Storage.saveCredentials(credentials) 保存流程凭证
Storage.getSettings() 获取用户设置
Storage.saveSettings(settings) 保存用户设置
Storage.getSessions() 获取用户会话
Storage.saveSessions(sessions) 保存用户会话
Storage.getLibraryEntry(type,name) 获取特定类型的库条目
Storage.saveLibraryEntry(type,name,meta,body) 保存特定类型的库条目

Storage.init(settings)

初始化存储系统。

参数 描述
settings 运行时设置

返回一个在存储系统初始化时解析的 promise。

Storage.getFlows()

返回一个解析为运行时流程配置的 promise。

Storage.saveFlows(flows)

参数 描述
flows 流程配置对象,可以序列化为 JSON。

返回一个在流程配置被保存时解析的 promise。

Storage.getCredentials()

返回一个解析为运行时流程凭证的 promise。

Storage.saveCredentials(credentials)

参数 描述
credentials 凭证对象,可以序列化为 JSON。

返回一个在流程凭证被保存时解析的 promise。

Storage.getSettings()

返回一个解析为用户设置的 promise。

Storage.saveSettings(settings)

参数 描述
settings 设置对象,可以序列化为 JSON。

返回一个在设置被保存时解析的 promise。

Storage.getSessions()

返回一个解析为会话对象的 promise。

Storage.saveSessions(sessions)

参数 描述
sessions 会话对象,可以序列化为 JSON。

返回一个在会话被保存时解析的 promise。

库函数

注册库类型的节点允许用户在本地库中保存和检索内容。存储模块的以下功能用于访问这些内容。

条目可能与元数据相关联,例如,一个 function 条目包含识别函数提供多少输出的元数据。

Storage.getLibraryEntry(type,name)

参数 描述
type 库条目的类型,例如 flowsfunctionstemplates
name 要返回的条目的路径名

返回一个解析为结果的 promise。

如果 name 代表一个单一条目,则结果是条目的内容。例如,一个函数的代码。

如果 name 代表一个逻辑目录,则结果是一个目录列表数组。 数组的每个元素都是一个字符串(表示可以浏览的子目录)或者是一个具有 fn 属性的对象,提供条目的文件名以及与条目相关的任何其他元数据。

[ 'directory1',
  'directory2',
  { fn: 'File-1.js', outputs: 3 },
  { fn: 'File-2.js', outputs: 1 },
  { fn: 'File-3.js', outputs: 2 }
]

Storage.saveLibraryEntry(type,name,meta,body)

参数 描述
type 库条目的类型,例如 flowsfunctionstemplates
name 条目的路径名
meta 一个包含要与条目一起保存的附加元数据的对象
body 条目的主体

返回一个在条目被保存时解析的 promise。

弃用的库函数

在 0.10.7 之前的版本中,以下函数也被存储模块使用。

新实现此接口的模块 应该实现这些函数。

运行时将在向后兼容时使用它们,但 否则将使用 getLibraryEntry/saveLibraryEntry,并将其 type 参数设置为 'flows'

Storage.getAllFlows()

返回一个解析为包含库中所有流程的完整列表的对象的 promise。

Storage.getFlow(name)

返回一个解析为流程内容的 promise。

Storage.saveFlow(name,flow)

返回一个在流程被保存到库时解析的 promise。