mirror of
https://github.com/node-red/node-red.git
synced 2025-03-01 10:36:34 +00:00
Add api docs landing content
This commit is contained in:
@@ -20,6 +20,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* A WebSocket connection between the runtime and the editor.
|
||||
* @typedef CommsConnection
|
||||
* @type {object}
|
||||
* @property {string} session - a unique session identifier
|
||||
|
@@ -413,7 +413,7 @@ function setObjectProperty(msg,prop,value,createMissing) {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
/*!
|
||||
* Get value of environment variable.
|
||||
* @param {Node} node - accessing node
|
||||
* @param {String} name - name of variable
|
||||
@@ -439,7 +439,7 @@ function getSetting(node, name) {
|
||||
* @param {String} value - the string to parse
|
||||
* @param {Node} node - the node evaluating the property
|
||||
* @return {String} The parsed string
|
||||
* @memberof @node-red/util_util
|
||||
* @memberof @node-red/util_util
|
||||
*/
|
||||
function evaluateEnvProperty(value, node) {
|
||||
var result;
|
||||
|
9
packages/node_modules/node-red/lib/red.js
vendored
9
packages/node_modules/node-red/lib/red.js
vendored
@@ -39,6 +39,9 @@ function checkVersion(userSettings) {
|
||||
* This module provides the full Node-RED application, with both the runtime
|
||||
* and editor components built in.
|
||||
*
|
||||
* The API this module exposes allows it to be embedded within another node.js
|
||||
* application.
|
||||
*
|
||||
* @namespace node-red
|
||||
*/
|
||||
module.exports = {
|
||||
@@ -125,7 +128,11 @@ module.exports = {
|
||||
|
||||
/**
|
||||
* This provides access to the internal nodes module of the
|
||||
* runtime.
|
||||
* runtime. The details of this API remain undocumented as they should not
|
||||
* be used directly.
|
||||
*
|
||||
* Most administrative actions should be performed use the runtime api
|
||||
* under [node-red.runtime]{@link node-red.runtime}.
|
||||
*
|
||||
* @memberof node-red
|
||||
*/
|
||||
|
Reference in New Issue
Block a user