Class ImportedPlugin<PluginCtr>

Type Parameters

PluginCtr extends typeof RoomPlugin | typeof WorkerPlugin = typeof RoomPlugin | typeof WorkerPlugin

Hierarchy

ImportedPlugin

Index

Methods

getPluginPackageJson importPlugin getDependencies isEnabled isRoomPlugin isWorkerPlugin

Constructors

Properties

localDirectory packageJson pluginCtr

Methods

`Static` getPluginPackageJson

getPluginPackageJson(pluginPath: string): Promise<undefined | PluginPackageJson>
Parameters
- pluginPath: string
Returns Promise<undefined | PluginPackageJson>
- Defined in src/handlers/PluginLoader.ts:80

`Static` importPlugin

importPlugin(pluginLoader: PluginLoader, pluginPath: string): Promise<ImportedPlugin<SomePluginCtr>>
Parameters
- pluginLoader: PluginLoader
- pluginPath: string
Returns Promise<ImportedPlugin<SomePluginCtr>>
- Defined in src/handlers/PluginLoader.ts:97

getDependencies

getDependencies(): {}
Returns {}
- Defined in src/handlers/PluginLoader.ts:174

isEnabled

isEnabled(room?: Room): undefined | boolean
Parameters
- Optional room: Room
Returns undefined | boolean
- Defined in src/handlers/PluginLoader.ts:161

isRoomPlugin

isRoomPlugin(): this is ImportedPlugin<typeof RoomPlugin>
Returns this is ImportedPlugin<typeof RoomPlugin>
- Defined in src/handlers/PluginLoader.ts:157

isWorkerPlugin

isWorkerPlugin(): this is ImportedPlugin<typeof WorkerPlugin>
Returns this is ImportedPlugin<typeof WorkerPlugin>
- Defined in src/handlers/PluginLoader.ts:153

Constructors

constructor

new ImportedPlugin<PluginCtr>(pluginLoader: PluginLoader, pluginCtr: PluginCtr, localDirectory: string, packageJson?: PluginPackageJson): ImportedPlugin<PluginCtr>
Type Parameters
- PluginCtr extends typeof WorkerPlugin | typeof RoomPlugin = typeof WorkerPlugin | typeof RoomPlugin
Parameters
- pluginLoader: PluginLoader
- pluginCtr: PluginCtr
- localDirectory: string
- packageJson: PluginPackageJson = {}
Returns ImportedPlugin<PluginCtr>
- Defined in src/handlers/PluginLoader.ts:146

Properties

`Readonly` localDirectory

localDirectory: string

`Readonly` packageJson

packageJson: PluginPackageJson = {}

`Readonly` pluginCtr

pluginCtr: PluginCtr

Generated using TypeDoc