存储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)

初始化存储系统。

参数 描述
设置 运行时设置

返回一个 Promise,当存储系统初始化完成时解析。

Storage.getFlows()

返回一个 Promise,解析为运行时流程配置。

Storage.saveFlows(flows)

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

返回一个 Promise,当流程配置保存完成时解析。

Storage.getCredentials()

返回一个 Promise,解析为运行时流程凭据。

Storage.saveCredentials(credentials)

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

返回一个 Promise,当流程凭据保存完成时解析。

Storage.getSettings()

返回一个 Promise,解析为用户设置。

Storage.saveSettings(settings)

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

返回一个 Promise,当设置保存完成时解析。

Storage.getSessions()

返回一个 Promise,解析为会话对象。

Storage.saveSessions(sessions)

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

返回一个 Promise,当会话保存完成时解析。

库函数

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

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

Storage.getLibraryEntry(type,name)

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

返回一个 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)

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

返回一个 Promise,当条目保存完成时解析。

已弃用的库函数

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

此接口的新实现不应实现这些函数。

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

Storage.getAllFlows()

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

Storage.getFlow(name)

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

Storage.saveFlow(name,flow)

返回一个 Promise,当流程保存到库时解析。