Skip to Content
Pulpfixer 2
DocumentationAPI ReferenceTypesPluginsClassesClass: abstract AbstractPlugin

pulpfixer v1.4.21


Class: abstract AbstractPlugin

Abstract class for plugins

To be used as a base class for all plugin addons

Use the register method to initialize the plugin

AbstractPlugin

Constructors

new AbstractPlugin()

new AbstractPlugin(settings): AbstractPlugin

Constructor

During startup, the plugin is initialized with the its settigns from pulpfixer registry

Parameters

settings

IPluginSettings

Plugin settings

Returns

AbstractPlugin

Properties

defaultSettings

defaultSettings: IPluginSettings

Default settings

Default plugin settings to save into pulpfixer registry


name

abstract readonly name: string

Plugin name

Methods

install()?

abstract optional install(): void

Install the plugin

Run during plugin installation

Returns

void


register()

abstract register(): void

Register the plugin

Run at pulpfixer startup

Returns

void

Last updated on