IPluginRecord | catana-backend

Data type corresponding to the information stored for each loaded plugin. Provides one-to-one mapping with the plugin's JSON file.

Hierarchy

IPluginRecord

Index

Properties

author

author: string

Author of the plugin

dependencies

dependencies: string[]

Names of the plugins this plugin depends on.

depsUrlTemplate

depsUrlTemplate: string

URL template for retrieving addresses of dependencies. If empty, thisUrlTemplate is used.

description

description: string

Description of the plugin

initScript

initScript: string

Name of the script (from scripts) to be automatically executed when the plugin is loaded.

name

name: string

Name of the plugin The name must be lowercase, single-word (i.e., no spaces), and may contain hyphens and underscores.

scripts

scripts: string[]

Names of scripts included in this plugin.

thisUrlTemplate

thisUrlTemplate: string

URL template for retrieving files of this plugin. Substring {name} will be replaced with the name of the plugin (defined in name field). Substring {file} will be replaced with the name of the script file (defined in scripts field).

version

version: string

Plugin version