Skip to main content

Class: PluginManager

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:24

Constructors

new PluginManager()

new PluginManager(): PluginManager

Returns

PluginManager

Properties

registry

readonly registry: Set<SapphirePluginHookEntry>

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:25

Methods

registerHook()

Call Signature

registerHook(hook: SapphirePluginHook, type: SyncPluginHooks, name?: string): this

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:27

Parameters
ParameterType
hookSapphirePluginHook
typeSyncPluginHooks
name?string
Returns

this

Call Signature

registerHook(hook: SapphirePluginAsyncHook, type: AsyncPluginHooks, name?: string): this

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:28

Parameters
ParameterType
hookSapphirePluginAsyncHook
typeAsyncPluginHooks
name?string
Returns

this


registerPostInitializationHook()

registerPostInitializationHook(hook: SapphirePluginHook, name?: string): PluginManager

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:43

Parameters

ParameterType
hookSapphirePluginHook
name?string

Returns

PluginManager


registerPostLoginHook()

registerPostLoginHook(hook: SapphirePluginAsyncHook, name?: string): PluginManager

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:51

Parameters

ParameterType
hookSapphirePluginAsyncHook
name?string

Returns

PluginManager


registerPreGenericsInitializationHook()

registerPreGenericsInitializationHook(hook: SapphirePluginHook, name?: string): PluginManager

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:35

Parameters

ParameterType
hookSapphirePluginHook
name?string

Returns

PluginManager


registerPreInitializationHook()

registerPreInitializationHook(hook: SapphirePluginHook, name?: string): PluginManager

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:39

Parameters

ParameterType
hookSapphirePluginHook
name?string

Returns

PluginManager


registerPreLoginHook()

registerPreLoginHook(hook: SapphirePluginAsyncHook, name?: string): PluginManager

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:47

Parameters

ParameterType
hookSapphirePluginAsyncHook
name?string

Returns

PluginManager


use()

use(plugin: typeof Plugin): PluginManager

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:55

Parameters

ParameterType
plugintypeof Plugin

Returns

PluginManager


values()

Call Signature

values(): Generator<SapphirePluginHookEntry, void>

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:71

Returns

Generator<SapphirePluginHookEntry, void>

Call Signature

values(hook: SyncPluginHooks): Generator<SapphirePluginHookEntry<SapphirePluginHook>, void>

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:72

Parameters
ParameterType
hookSyncPluginHooks
Returns

Generator<SapphirePluginHookEntry<SapphirePluginHook>, void>

Call Signature

values(hook: AsyncPluginHooks): Generator<SapphirePluginHookEntry<SapphirePluginAsyncHook>, void>

Defined in: projects/framework/src/lib/plugins/PluginManager.ts:73

Parameters
ParameterType
hookAsyncPluginHooks
Returns

Generator<SapphirePluginHookEntry<SapphirePluginAsyncHook>, void>