Carbon
Core/Classes

Plugin

The base class for all plugins

Extended by

Constructors

Constructor

new Plugin(): Plugin

Returns

Plugin

Properties

PropertyModifierTypeDescription
idabstractstringAn ID that identifies the plugin uniquely between all other used plugins in the Client

Methods

registerClient()?

optional registerClient(client): void | Promise<void>

Registers the client with this plugin

Parameters

ParameterTypeDescription
clientClientThe client to register

Returns

void | Promise<void>


registerRoutes()?

optional registerRoutes(client): void | Promise<void>

Registers the routes of this plugin with the client

Parameters

ParameterTypeDescription
clientClientThe client to register the routes with

Returns

void | Promise<void>

On this page