@pumpkin-plugins/plugin-kit API / plugin / PluginBase

Abstract Class: PluginBase

Defined in: tools/plugin-kit/src/plugin.ts:10

Base class for plugins, keeping metadata, lifecycle hooks, logging and update checks consistent.

Extends

• Plugin

Properties

info

readonly info: PluginInfo

Defined in: tools/plugin-kit/src/plugin.ts:12

The plugin's README and metadata declaration.

Methods

metadata()

metadata(): PluginMetadata

Defined in: tools/plugin-kit/src/plugin.ts:24

Builds Pumpkin's plugin metadata from the shared info declaration.

Returns

PluginMetadata

Overrides

Plugin.metadata

---

onLoad()

onLoad(ctx): void

Defined in: tools/plugin-kit/src/plugin.ts:29

Registers the API's pending events and runs the plugin's load hook.

Parameters

ctx

Context

Returns

void

Overrides

Plugin.onLoad

---

onUnload()

onUnload(ctx): void

Defined in: tools/plugin-kit/src/plugin.ts:35

Runs the plugin's unload hook after the API's unload handler.

Parameters

ctx

Context

Returns

void

Overrides

Plugin.onUnload