@node-red/editor-api

This module provides an Express application to serve the Node-RED editor.

It implements the Node-RED HTTP Admin API the Editor uses to interact with the Node-RED runtime.

Members

httpAdmin : ExpressApplication
auth : { ... }

httpAdmin : ExpressApplication

The Express app used to serve the Node-RED Editor

init(settings, _server, storage, runtimeAPI)

Initialise the module.

Parameters:
Name Type Description
settings Object

The runtime settings

_server HTTPServer

An instance of HTTP Server

storage Storage

An instance of Node-RED Storage

runtimeAPI Runtime

An instance of Node-RED Runtime

start() → {Promise}

Start the module.

Returns:
Type:
Promise

resolves when the application is ready to handle requests

stop() → {Promise}

Stop the module.

Returns:
Type:
Promise

resolves when the application is stopped