@node-red/runtime.plugins

getPlugin(opts) → {Promise.<PluginDefinition>}

Gets a plugin definition from the registry

Parameters:
Name Type Description
opts Object
Name Type Description
id String

the id of the plugin to get

user User

the user calling the api

req Object

the request to log (optional)

Returns:
Type:
Promise.<PluginDefinition>
  • the plugin definition

getPluginCatalogs(opts) → {Promise.<Object>}

Gets all registered module message catalogs

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api

lang User

the i18n language to return. If not set, uses runtime default (en-US)

req Object

the request to log (optional)

Returns:
Type:
Promise.<Object>
  • the message catalogs

getPluginConfigs(opts) → {Promise.<NodeInfo>}

Gets the editor content for all registered plugins

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api

user User

the user calling the api

req Object

the request to log (optional)

Returns:
Type:
Promise.<NodeInfo>
  • the node information

getPluginList() → {Promise.<NodeInfo>}

Gets the editor content for an individual plugin

Parameters:
Name Type Description
opts.lang String

the locale language to return

opts.user User

the user calling the api

opts.req Object

the request to log (optional)

Returns:
Type:
Promise.<NodeInfo>
  • the node information

getPluginsByType(opts) → {Promise.<Array>}

Gets all plugin definitions of a given type

Parameters:
Name Type Description
opts Object
Name Type Description
type String

the type of the plugins to get

user User

the user calling the api

req Object

the request to log (optional)

Returns:
Type:
Promise.<Array>
  • the plugin definitions