1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/red/runtime-api/index.js

67 lines
1.9 KiB
JavaScript
Raw Normal View History

2018-04-15 12:18:10 +02:00
/**
* Copyright JS Foundation and other contributors, http://js.foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
2018-04-23 12:21:02 +02:00
/**
* A user accessing the API
* @typedef User
* @type {object}
*/
2018-04-15 12:18:10 +02:00
2018-04-20 21:50:20 +02:00
var runtime;
2018-04-15 12:18:10 +02:00
/**
* @namespace RED
*/
var api = module.exports = {
2018-04-20 21:50:20 +02:00
init: function(_runtime, redUtil) {
runtime = _runtime;
2018-04-23 12:21:02 +02:00
api.comms.init(runtime);
2018-04-15 12:18:10 +02:00
api.flows.init(runtime);
api.nodes.init(runtime);
api.settings.init(runtime);
api.library.init(runtime);
2018-04-20 21:50:20 +02:00
api.projects.init(runtime);
2018-04-15 12:18:10 +02:00
},
comms: require("./comms"),
flows: require("./flows"),
library: require("./library"),
nodes: require("./nodes"),
2018-04-20 21:50:20 +02:00
settings: require("./settings"),
projects: require("./projects"),
2018-04-23 12:21:02 +02:00
/**
* Returns whether the runtime is started
* @param {Object} opts
* @param {User} opts.user - the user calling the api
* @return {Promise<Boolean>} - whether the runtime is started
* @memberof RED
*/
isStarted: function(opts) {
return Promise.resolve(runtime.isStarted());
},
2018-04-15 12:18:10 +02:00
2018-04-23 12:21:02 +02:00
/**
* Returns version number of the runtime
* @param {Object} opts
* @param {User} opts.user - the user calling the api
* @return {Promise<String>} - the runtime version number
* @memberof RED
*/
2018-04-20 21:50:20 +02:00
version: function(opts) {
return Promise.resolve(runtime.version());
}
2018-04-15 12:18:10 +02:00
}