This API provides access to read and write plugins. A plugin needs to be assigned to a WebSocket server instance to work.
| Property | Type | Description |
|---|---|---|
| plugins | Array<PluginConfig> |
List of configured plugins. |
| Property | Type | Description |
|---|---|---|
| id | string |
ID of the plugin. |
| description | string |
Optional: The description provided by the plugin |
| code | string |
The JavaScript plugin code. See chapter plugin how to write a plugin. |
Create a new plugin.
| Property | Type | Description |
|---|---|---|
| plugin | The plugin configuration object. |
| Property | Type | Description |
|---|---|---|
| id | string |
ID of the plugin. |
| code | string |
The JavaScript plugin code. See chapter plugin how to write a plugin. |
Updates an existing plugin configuration.
| Property | Type | Description |
|---|---|---|
| plugin | The plugin configuration object. |
Deletes an existing plugin configuration.
Updates the package.json file inside the plugins directory and installs dependencies. (since 3.4.0)
| Property | Type | Description |
|---|---|---|
| name | string |
|
| version | string |
|
| dependencies | Object<string, string> |