Class Plugin

constructor

• new Plugin(o: Plugin | PluginCfg): Plugin

  Plugin constructor

  Parameters

  • o: Plugin | PluginCfg

  Returns Plugin

Optionalconfiguration

Optionaldeploy_private_key

Optionaldescription

Optionaldocumentation_link

Optionalhas_auth

Optionalhas_theme

Optionalid

location

name

source

Optionalunsafe

Optionalversion

delete

• delete(): Promise<void>

  Delete plugin

  Returns Promise<void>

dependant_views

• dependant_views(): Promise<string[]>

  List of views relay on this plugin

  Returns Promise<string[]>

ready_for_mobile

• ready_for_mobile(): boolean

  Returns boolean

upgrade_version

• upgrade_version(
      requirePlugin: (arg0: Plugin, arg1: boolean) => Plugin,
      newVersion?: string,
  ): Promise<void>

  Upgrade plugin version

  Parameters

  • requirePlugin: (arg0: Plugin, arg1: boolean) => Plugin
  • OptionalnewVersion: string

  Returns Promise<void>

upsert

• upsert(): Promise<void>

  Update or Insert plugin

  Returns Promise<void>

Staticfind

• find(where?: Where): Promise<Plugin[]>

  Find plugins

  Parameters

  • Optionalwhere: Where

    where object

  Returns Promise<Plugin[]>

  returns plugins list

StaticfindOne

• findOne(where: Where): Promise<Plugin | null>

  Find one plugin

  Parameters

  • where: Where

    where object

  Returns Promise<Plugin | null>

  return existing plugin or new plugin

Staticget_cached_plugins

• get_cached_plugins(): Plugin[]

  Returns Plugin[]

Staticis_fixed_plugin

• is_fixed_plugin(name: string): boolean

  check if plugin is base-plugin or sbadmin2

  Parameters

  • name: string

  Returns boolean

Staticread_local_store_entries

• read_local_store_entries(): Promise<any>

  Returns Promise<any>

Staticstore_by_name

• store_by_name(name: string, endpoint?: string): Promise<Plugin | null>

  Parameters

  • name: string
  • Optionalendpoint: string

  Returns Promise<Plugin | null>

Staticstore_plugins_available

• store_plugins_available(msgs?: string[]): Promise<Plugin[]>

  List plugins available in store

  Parameters

  • Optionalmsgs: string[]

    optional packages/plugins-loader/plugin_installer.jsmessages array

  Returns Promise<Plugin[]>

Staticstore_plugins_available_from_store

• store_plugins_available_from_store(endpoint?: string): Promise<Plugin[]>

  Parameters

  • Optionalendpoint: string

  Returns Promise<Plugin[]>