Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PluginGenerator<API, InitOption>

Plugin generator interface for registering plugins

Type Parameters

  • API

  • InitOption

Hierarchy

  • PluginGenerator

Index

Properties

Methods

Properties

tag: string

Unique plugin identifier (read-only)

version?: string

Plugin version

name?: string

Plugin name

Methods

  • verify(runtime: IRuntime): boolean
  • Environment check before plugin installation, returns whether the plugin can run

    Parameters

    • runtime: IRuntime

    Returns boolean

  • setup(context: PluginContext, runtime: IRuntime, options: InitOption): API
  • Initialize the plugin

    Parameters

    • context: PluginContext

      Plugin context for message registration and dispatching

    • runtime: IRuntime

      Runtime instance identifying the target platform

    • options: InitOption

      Initialization options

    Returns API