Library Store API

从 1.3.0 开始

Node-RED 编辑器中的 Import/Export 对话框提供了一种将流程和节点保存到本地库的方法。

此本地库由 Storage API 管理。默认存储在 ~/.node-red/lib 下。

Library Store API 是一种插件机制，可用于提供将其内容存储在其他位置的库，而不仅仅是本地文件。

Node-RED 提供了一个 File Store 插件 可用于添加存储在本地文件系统上的库。这可以使用， 例如，要通过 Dropbox 等工具在共享文件系统上创建库，要将 与您正在合作的其他开发人员共享流更容易。

添加 File Store 库

  1. 编辑 Node-RED 设置文件 - 通常~/.node-red/settings.js
  2. 找到该部分并添加一个部分（如果尚不存在）editorTheme library
  3. 在该部分下，添加一个数组。在该数组中，您可以根据需要添加任意数量的新文件存储源 source
1
2
3
4
5
6
7
8
9
10
11
12
13
editorTheme: {
     library: {
         sources: [
             {
                 id: "team-collaboration-library",
                 type: "node-red-library-file-store",
                 path: "/Users/tom/work/team-library/",
                 label: "Team collaboration",
                 icon: "font-awesome/fa-users"
             }
         ]
     },
 }

配置对象可以具有以下属性：

字段 描述
id 必需
库的唯一 url 安全标识符。应仅包含字母、数字和符号 。- _
type 必需
必须设置为node-red-library-file-store
path 必需
库应存储位置的绝对路径
label 要在编辑器中使用的可选标签，否则将使用 id
icon FontAwesome 4.7 中的可选图标。
types 默认情况下，该库将用于存储所有类型的对象。可以通过将此属性设置为可接受类型的数组来将其限制为某些类型。
例如，要将其限制为仅流，请将此属性设置为 ["flows"]
readOnly 要使其成为只读库，以便只能用于导入，请将此属性设置为 true

创建新的 Store 插件

要创建由不同类型的存储支持的商店，您需要创建一个新插件。

该插件打包为 npm 模块，带有一个文件 package.json

以下代码可以用作插件的起点。您还应该参考 File Store 插件。

package.json

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "name": "your-custom-library-store",
    "version": "1.0.0",
    "description": "A Custom Library plugin for Node-RED",
    "keywords": [
        "node-red"
    ],
    "node-red": {
        "plugins": {
            "customstore": "store.js"
        }
    }
}

store.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
module.exports = function(RED) {

    // This must be a unique identifier for the library store type
    const PLUGIN_TYPE_ID = "node-red-library-custom-store";

    class CustomStorePlugin {

        /**
         * @param {object} config an object containing the configuration for an
         *                        instance of the store
         */
        constructor(config) {
            // Required properties
            this.type = PLUGIN_TYPE_ID;
            this.id = config.id;
            this.label = config.label;
        }

        /**
         * Initialise the store.
         */
        async init() {
        }

        /**
         * Get an entry from the store
         * @param {string} type The type of entry, for example, "flow"
         * @param {string} path The path to the library entry
         * @return if 'path' resolves to a single entry, it returns the contents
         *         of that entry.
         *         if 'path' resolves to a 'directory', it returns a listing of
         *         the contents of the directory
         *         if 'path' is not valid, it should throw a suitable error
         */
        async getEntry(type,path) {
            throw new Error("Not implemented")
        }

        /**
         * Save an entry to the library
         * @param {string} type The type of entry, for example, "flow"
         * @param {string} path The path to the library entry
         * @param {object} meta An object of key/value meta data about the entry
         * @param {string} body The entry contents
         */
        async saveEntry(type,path,meta,body) {
            throw new Error("Not implemented")
        }
    }

    // Register the plugin.
    RED.plugins.registerPlugin(PLUGIN_TYPE_ID, {
        // This tells Node-RED the plugin is a library source plugin
        type: "node-red-library-source",
        class: CustomStorePlugin
    })
}