Class Plugin<T>

Introduction

Plugins are the fundamental building blocks of SerenityJS. They are used to add additional functionality to the server, which allows total control over the server.

There are 2 types of plugins that are defined in the PluginType enum: Addon & Api

Addon plugins add additional functionality to the server, without an exposed API. This means external plugins cannot directly interact with the plugins API. Api plugins add additional functionality to the server, with an exposed API for other plugins to use. This means external plugins can directly interact with the plugins API.

Class Extending Plugin

import { Plugin, PluginType, PluginEvents } from "@serenityjs/plugins";

class SamplePlugin extends Plugin {
  public readonly type = PluginType.Addon;

  public constructor() {
    super("sample-plugin", "1.0.0");
  }

  public onInitialize(): void {}

  public onStartUp(): void {}

  public onShutDown(): void {}
}

export default new SamplePlugin();

Type Parameters

T = unknown

Hierarchy

Emitter<T>
- Plugin

Implements

PluginOptions

Index

Constructors

constructor

new Plugin<T = unknown>(
    identifier: string,
    version: string,
    options?: Partial<PluginOptions>,
): Plugin<T>
Create a new plugin instance.
Type Parameters
- T = unknown
Parameters
- identifier: string
  The identifier of the plugin.
- version: string
  The version of the plugin.
- Optionaloptions: Partial<PluginOptions>
  The options of the plugin.
Returns Plugin<T>
Overrides Emitter<T>.constructor
- Defined in plugins/src/plugin.ts:145

Properties

`Readonly`blocks

blocks: PluginBlockRegistry = ...

The block registry for the plugin.

Note

Only register types/traits during the onInitialize event.

`Readonly`config

config: unknown = {}

The config of the plugin.

`Readonly`entities

entities: PluginEntityRegistry = ...

The entity registry for the plugin.

Note

Only register types/traits during the onInitialize event.

`Readonly`identifier

identifier: string

The identifier of the plugin.

isBundled

isBundled: boolean

Whether or not the plugin is bundled.

Note

This is only available after the plugin is initialized.

`Readonly`items

items: PluginItemRegistry = ...

The item registry for the plugin.

Note

Only register types/traits during the onInitialize event.

`Readonly`logger

logger: Logger

The logger for the plugin.

path

path: string

The path to the plugin.

Note

This is only available after the plugin is initialized.

pipeline

pipeline: Pipeline

The plugin pipeline the plugin is in.

Note

This is only available after the plugin is initialized.

`Readonly`priority

priority: PluginPriority = PluginPriority.Normal

The priority of the plugin.

Note

This is used to determine the order in which plugins are loaded.

`Readonly`resources

resources: Set<ResourcePack> = ...

The resource packs provided by the plugin.

serenity

serenity: Serenity

The serenity instance of the server.

Note

This is only available after the plugin is initialized.

`Readonly`version

version: string

The version of the plugin.

Accessors

maxListeners

get maxListeners(): number
The maximum number of listeners for the plugin.

Returns number
Implementation of PluginOptions.maxListeners
Inherited from Emitter.maxListeners
- Defined in emitter/dist/index.d.ts:11
set maxListeners(value: number): void
The maximum number of listeners for the plugin.
Parameters
- value: number
Returns void
Implementation of PluginOptions.maxListeners
Inherited from Emitter.maxListeners
- Defined in emitter/dist/index.d.ts:12

Methods

after

after<K extends string | number | symbol>(
event: K,
listener: AfterListener<ForceArray<T[K]>>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: AfterListener<ForceArray<T[K]>>
Returns this
Inherited from Emitter.after
- Defined in emitter/dist/index.d.ts:20

before

before<K extends string | number | symbol>(
event: K,
listener: Listener<ForceArray<T[K]>, boolean>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<ForceArray<T[K]>, boolean>
Returns this
Inherited from Emitter.before
- Defined in emitter/dist/index.d.ts:19

defineConfig

defineConfig<T>(definition: T): T
Define the config for the plugin.
Type Parameters
- T
Parameters
- definition: T
  The config definition.
Returns T
The config object.
- Defined in plugins/src/plugin.ts:314

emit

emit<K extends string | number | symbol>(
event: K,
...arguments_: ForceArray<T[K]>,
): boolean
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- ...arguments_: ForceArray<T[K]>
Returns boolean
Inherited from Emitter.emit
- Defined in emitter/dist/index.d.ts:13

hasFile

hasFile(path: string): boolean
Check if a file exists in the plugin data directory.
Parameters
- path: string
  The path to the file to check.
Returns boolean
True if the file exists, otherwise false.
- Defined in plugins/src/plugin.ts:216

on

on<K extends string | number | symbol>(
event: K,
listener: Listener<ForceArray<T[K]>>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<ForceArray<T[K]>>
Returns this
Inherited from Emitter.on
- Defined in emitter/dist/index.d.ts:18

once

once<K extends string | number | symbol>(
event: K,
listener: Listener<ForceArray<T[K]>>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<ForceArray<T[K]>>
Returns this
Inherited from Emitter.once
- Defined in emitter/dist/index.d.ts:21

onceAfter

onceAfter<K extends string | number | symbol>(
event: K,
listener: AfterListener<ForceArray<T[K]>>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: AfterListener<ForceArray<T[K]>>
Returns this
Inherited from Emitter.onceAfter
- Defined in emitter/dist/index.d.ts:23

onceBefore

onceBefore<K extends string | number | symbol>(
event: K,
listener: Listener<ForceArray<T[K]>, boolean>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<ForceArray<T[K]>, boolean>
Returns this
Inherited from Emitter.onceBefore
- Defined in emitter/dist/index.d.ts:22

onInitialize

onInitialize(_plugin: Plugin): void
Called when the plugin is initialized.
Parameters
- _plugin: Plugin
Returns void
Implementation of PluginOptions.onInitialize
- Defined in plugins/src/plugin.ts:191

onShutDown

onShutDown(_plugin: Plugin): void
Called when the plugin is shut down.
Parameters
- _plugin: Plugin
Returns void
Implementation of PluginOptions.onShutDown
- Defined in plugins/src/plugin.ts:207

onStartUp

onStartUp(_plugin: Plugin): void
Called when the plugin is started up.
Parameters
- _plugin: Plugin
Returns void
Implementation of PluginOptions.onStartUp
- Defined in plugins/src/plugin.ts:199

readFile

readFile(path: string): null | Buffer<ArrayBufferLike>
Read a file from the plugin data directory.
Parameters
- path: string
  The path to the file to read.
Returns null | Buffer<ArrayBufferLike>
The file data if it exists, otherwise null.
- Defined in plugins/src/plugin.ts:248

remove

remove<K extends string | number | symbol>(
event: K,
listener: Listener<ForceArray<T[K]>>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<ForceArray<T[K]>>
Returns this
Inherited from Emitter.remove
- Defined in emitter/dist/index.d.ts:24

removeAfter

removeAfter<K extends string | number | symbol>(
event: K,
listener: AfterListener<ForceArray<T[K]>>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: AfterListener<ForceArray<T[K]>>
Returns this
Inherited from Emitter.removeAfter
- Defined in emitter/dist/index.d.ts:26

removeAll

removeAll<K extends string | number | symbol>(event?: K): this
Type Parameters
- K extends string | number | symbol
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAll
- Defined in emitter/dist/index.d.ts:27

removeAllAfter

removeAllAfter<K extends string | number | symbol>(event?: K): this
Type Parameters
- K extends string | number | symbol
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAllAfter
- Defined in emitter/dist/index.d.ts:29

removeAllBefore

removeAllBefore<K extends string | number | symbol>(event?: K): this
Type Parameters
- K extends string | number | symbol
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAllBefore
- Defined in emitter/dist/index.d.ts:28

removeBefore

removeBefore<K extends string | number | symbol>(
event: K,
listener: Listener<ForceArray<T[K]>, boolean>,
): this
Type Parameters
- K extends string | number | symbol
Parameters
- event: K
- listener: Listener<ForceArray<T[K]>, boolean>
Returns this
Inherited from Emitter.removeBefore
- Defined in emitter/dist/index.d.ts:25

removePath

removePath(path: string): this
Parameters
- path: string
Returns this
Inherited from Emitter.removePath
- Defined in emitter/dist/index.d.ts:30

resolve

resolve<T extends Plugin<unknown>>(identifier: string): null | T
Resolve a plugin by its identifier
Type Parameters
- T extends Plugin<unknown>
Parameters
- identifier: string
  The identifier of the plugin to resolve.
Returns null | T
The plugin instance if found, otherwise null.
- Defined in plugins/src/plugin.ts:173

writeFile

writeFile(path: string, data: string | Buffer<ArrayBufferLike>): void
Write a file to the plugin data directory.
Parameters
- path: string
  The path to the file to write.
- data: string | Buffer<ArrayBufferLike>
  The file data to write.
Returns void
- Defined in plugins/src/plugin.ts:280

Class Plugin<T>

Introduction

Class Extending Plugin

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Plugin<T>

Properties

Readonlyblocks

Note

Readonlyconfig

Readonlyentities

Note

Readonlyidentifier

isBundled

Note

Readonlyitems

Note

Readonlylogger

path

Note

pipeline

Note

Readonlypriority

Note

Readonlyresources

serenity

Note

Readonlyversion

Accessors

maxListeners

Returns number

Parameters

Returns void

Methods

after

Type Parameters

Parameters

Returns this

before

Type Parameters

Parameters

Returns this

defineConfig

Type Parameters

Parameters

Returns T

emit

Type Parameters

Parameters

Returns boolean

hasFile

Parameters

Returns boolean

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

onceAfter

Type Parameters

Parameters

Returns this

onceBefore

Type Parameters

Parameters

Returns this

onInitialize

`Readonly`blocks

`Readonly`config

`Readonly`entities

`Readonly`identifier

`Readonly`items

`Readonly`logger

`Readonly`priority

`Readonly`resources

`Readonly`version