Interface PluginHooks<Config, Exports>

interface PluginHooks<Config, Exports> {
    onInit?(ctx): void | Exports | Promise<Exports>;
    onStart?(ctx): void | Promise<void>;
    onEvent?<T>(event, ctx): void;
    onConfigChange?(newConfig, ctx): void;
    onDestroy?(ctx): void | Promise<void>;
}

Type Parameters

Config = unknown
Exports = unknown

Hierarchy (view full)

PluginHooks
- PluginDefinition

Index

Methods

onInit? onStart? onEvent? onConfigChange? onDestroy?

Methods

`Optional` onInit

onInit(ctx): void | Exports | Promise<Exports>
Parameters
- ctx: PluginContext
Returns void | Exports | Promise<Exports>
- Defined in types/index.ts:275

`Optional` onStart

onStart(ctx): void | Promise<void>
Parameters
- ctx: PluginContext
Returns void | Promise<void>
- Defined in types/index.ts:276

`Optional` onEvent

onEvent<T>(event, ctx): void
Type Parameters
- T extends PlayerEventType
Parameters
- event: PlayerEventBase<T>
- ctx: PluginContext
Returns void
- Defined in types/index.ts:277

`Optional` onConfigChange

onConfigChange(newConfig, ctx): void
Parameters
- newConfig: Partial<Config>
- ctx: PluginContext
Returns void
- Defined in types/index.ts:281

`Optional` onDestroy

onDestroy(ctx): void | Promise<void>
Parameters
- ctx: PluginContext
Returns void | Promise<void>
- Defined in types/index.ts:282