跳到主要内容

Class: Plugin<GlobalAdapters>

Defined in: packages/ov0/src/core/plugin/plugin.ts:36

插件管理器,提供插件级别的注册、运行时变量和方法 第一个泛型参数传递所有适配器导出类型的联合类型,其作用于通过Plugin实例访问的所有defineListener方法

Type Parameters

GlobalAdapters

GlobalAdapters extends IAdapterExport = IDefaultAdapterExport

Implements

  • IPluginBase

Constructors

Constructor

new Plugin<GlobalAdapters>(config): Plugin<GlobalAdapters>

Defined in: packages/ov0/src/core/plugin/plugin.ts:42

Parameters

config

TPluginParam0

Returns

Plugin<GlobalAdapters>

Properties

DATA_DIRECTORY_PATH

DATA_DIRECTORY_PATH: string = ''

Defined in: packages/ov0/src/core/plugin/plugin.ts:40

插件运行时的数据存放目录,该目录用于存放你插件运行时产生的所有的数据和资源,用户卸载插件时可自行选择是否删掉该目录

Implementation of

IPluginBase.DATA_DIRECTORY_PATH


pluginID

pluginID: string

Defined in: packages/ov0/src/core/plugin/plugin.ts:38

插件唯一标识符,必须使用插件解压到plugins目录下的文件夹名称

Implementation of

IPluginBase.pluginID


ROOT_DIRECTORY_PATH

ROOT_DIRECTORY_PATH: string = ''

Defined in: packages/ov0/src/core/plugin/plugin.ts:39

插件运行时所在根目录,一般用不到,除非主动卸载自己

Implementation of

IPluginBase.ROOT_DIRECTORY_PATH

Methods

defineAdapter()

defineAdapter(config, component): Adapter

Defined in: packages/ov0/src/core/plugin/plugin.ts:133

定义适配器组件(事件发布组件)

Parameters

config

IAdapterConfig

详见 Adapter 参数

component

(ctx) => void | Function | Promise<void | Function>

函数式组件,回调函数的第一个参数是适配器实例

Returns

Adapter


defineListener()

defineListener<Adapters>(config, component): Listener<Adapters>

Defined in: packages/ov0/src/core/plugin/plugin.ts:118

定义监听器组件 通常每个业务模块都会导出一个通过该方法创建的监听器实例

Type Parameters

Adapters

Adapters extends IAdapterExport

Parameters

config

IListenerConfig<Adapters>

详见 Listener 参数

component

(ctx) => void | Function | Promise<void | Function>

函数式组件,回调函数的第一个参数是监听器实例

Returns

Listener<Adapters>


onBeforeUnmount()

onBeforeUnmount(callback): void

Defined in: packages/ov0/src/core/plugin/plugin.ts:99

动态注册插件卸载前钩子,避免循环依赖模块执行顺序问题

Parameters

callback

undefined | () => void

Returns

void


onMounted()

onMounted(callback): void

Defined in: packages/ov0/src/core/plugin/plugin.ts:91

动态注册插件挂载钩子,避免循环依赖模块执行顺序问题

Parameters

callback

undefined | (e) => void

Returns

void


onUnmounted()

onUnmounted(callback): void

Defined in: packages/ov0/src/core/plugin/plugin.ts:107

动态注册插件卸载后钩子,避免循环依赖模块执行顺序问题

Parameters

callback

undefined | (e) => void

Returns

void


use()

use(app): void

Defined in: packages/ov0/src/core/plugin/plugin.ts:77

注册监听器或适配器或组件等,单独引入Listener或Adapter时可用该方法注册

Parameters

app

Listener | Adapter

Adapter | Listener<GlobalAdapters>

Returns

void