plugin-tls 3.3.3 → 3.5.0

package/doc/api/plugin-tls.pluginhost.md

@@ -1,177 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginHost](./plugin-tls.pluginhost.md)
-
-## PluginHost class
-
-插件的宿主
-
-**Signature:**
-
-```typescript
-export declare class PluginHost<Plugin extends IPlugin<typeof PluginHost, any> = IPlugin<typeof PluginHost, any>> extends WebDestroyable 
-```
-**Extends:** WebDestroyable
-
-## Remarks
-
-插件宿主 就是 拥有插件机制的宿主
-
-子类需要在构建函数中调用 `this.pluginManager.created(this);`
-
-之所以没写在该类中的函数中，是因为 `this.pluginManager.created(this)` 通常会在构建函数执行的最后时才调用； 如果像下面写在该类的构建函数中，然后子类通过 `super()` 来调用，这样就会导致 `this.pluginManager.created(this)` 不是在最后的执行；
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[\_pluginManager](./plugin-tls.pluginhost._pluginmanager.md)
-
-
-</td><td>
-
-`protected`
-
-`static`
-
-
-</td><td>
-
-[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;any&gt;
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[pluginManager](./plugin-tls.pluginhost.pluginmanager.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;any, [IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;any, any&gt;&gt;
-
-
-</td><td>
-
-插件管理器 
-
-
-</td></tr>
-<tr><td>
-
-[pluginManager](./plugin-tls.pluginhost.pluginmanager.md)
-
-
-</td><td>
-
-`static`
-
-`readonly`
-
-
-</td><td>
-
-[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;any, [IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;any, any&gt;&gt;
-
-
-</td><td>
-
-插件管理器
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[destroyThis()](./plugin-tls.pluginhost.destroythis.md)
-
-
-</td><td>
-
-
-</td><td>
-
-销毁实例
-
-
-</td></tr>
-<tr><td>
-
-[use(plugin, options)](./plugin-tls.pluginhost.use.md)
-
-
-</td><td>
-
-
-</td><td>
-
-实例的注册插件的方法
-
-
-</td></tr>
-<tr><td>
-
-[use(plugin, options)](./plugin-tls.pluginhost.use.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-使用插件、注册插件
-
-
-</td></tr>
-</tbody></table>
-

package/doc/api/plugin-tls.pluginhost.pluginmanager.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginHost](./plugin-tls.pluginhost.md) &gt; [pluginManager](./plugin-tls.pluginhost.pluginmanager.md)
-
-## PluginHost.pluginManager property
-
-插件管理器
-
-**Signature:**
-
-```typescript
-static get pluginManager(): PluginManager<any, IPlugin<any, any>>;
-```

package/doc/api/plugin-tls.pluginhost.use.md

@@ -1,70 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginHost](./plugin-tls.pluginhost.md) &gt; [use](./plugin-tls.pluginhost.use.md)
-
-## PluginHost.use() method
-
-使用插件、注册插件
-
-**Signature:**
-
-```typescript
-static use<Plugin extends IPlugin<typeof PluginHost, any>>(plugin: Plugin, ...options: FormatUsePluginParameters<Plugin>): void | ReturnType<Plugin["used"]>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-plugin
-
-
-</td><td>
-
-Plugin
-
-
-</td><td>
-
-插件
-
-
-</td></tr>
-<tr><td>
-
-options
-
-
-</td><td>
-
-[FormatUsePluginParameters](./plugin-tls.formatusepluginparameters.md)<!-- -->&lt;Plugin&gt;
-
-
-</td><td>
-
-传递给插件的选项
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void \| ReturnType&lt;Plugin\["used"\]&gt;
-

package/doc/api/plugin-tls.pluginmanager._constructor_.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManager](./plugin-tls.pluginmanager.md) &gt; [(constructor)](./plugin-tls.pluginmanager._constructor_.md)
-
-## PluginManager.(constructor)
-
-Constructs a new instance of the `PluginManager` class
-
-**Signature:**
-
-```typescript
-constructor(host?: HostClassType);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-host
-
-
-</td><td>
-
-HostClassType
-
-
-</td><td>
-
-_(Optional)_ 插件的宿主
-
-
-</td></tr>
-</tbody></table>
-

package/doc/api/plugin-tls.pluginmanager.created.md

@@ -1,58 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManager](./plugin-tls.pluginmanager.md) &gt; [created](./plugin-tls.pluginmanager.created.md)
-
-## PluginManager.created() method
-
-插件宿主创建实例时调用
-
-**Signature:**
-
-```typescript
-created(hostInst: HostInst<HostClassType>): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-hostInst
-
-
-</td><td>
-
-[HostInst](./plugin-tls.hostinst.md)<!-- -->&lt;HostClassType&gt;
-
-
-</td><td>
-
-插件宿主的新实例
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-会调用每个插件的 [IPlugin.created()](./plugin-tls.iplugin.created.md) 方法
-

package/doc/api/plugin-tls.pluginmanager.destroyed.md

@@ -1,58 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManager](./plugin-tls.pluginmanager.md) &gt; [destroyed](./plugin-tls.pluginmanager.destroyed.md)
-
-## PluginManager.destroyed() method
-
-插件宿主被销毁时调用
-
-**Signature:**
-
-```typescript
-destroyed(hostInst: HostInst<HostClassType>): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-hostInst
-
-
-</td><td>
-
-[HostInst](./plugin-tls.hostinst.md)<!-- -->&lt;HostClassType&gt;
-
-
-</td><td>
-
-被销毁的插件实例
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-会调用每个插件的 [IPlugin.destroyed()](./plugin-tls.iplugin.destroyed.md) 方法
-

package/doc/api/plugin-tls.pluginmanager.host.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManager](./plugin-tls.pluginmanager.md) &gt; [host](./plugin-tls.pluginmanager.host.md)
-
-## PluginManager.host property
-
-插件的宿主
-
-**Signature:**
-
-```typescript
-host: HostClassType;
-```

package/doc/api/plugin-tls.pluginmanager.instuse.md

@@ -1,86 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManager](./plugin-tls.pluginmanager.md) &gt; [instUse](./plugin-tls.pluginmanager.instuse.md)
-
-## PluginManager.instUse() method
-
-插件宿主实例的注册插件的方法
-
-**Signature:**
-
-```typescript
-instUse<P extends Plugin>(hostInst: HostInst<HostClassType>, plugin: P, ...options: FormatUsePluginParameters<P>): PluginCreatedReturnType<P> | void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-hostInst
-
-
-</td><td>
-
-[HostInst](./plugin-tls.hostinst.md)<!-- -->&lt;HostClassType&gt;
-
-
-</td><td>
-
-插件宿主的新实例
-
-
-</td></tr>
-<tr><td>
-
-plugin
-
-
-</td><td>
-
-P
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-options
-
-
-</td><td>
-
-[FormatUsePluginParameters](./plugin-tls.formatusepluginparameters.md)<!-- -->&lt;P&gt;
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[PluginCreatedReturnType](./plugin-tls.plugincreatedreturntype.md)<!-- -->&lt;P&gt; \| void
-
-## Remarks
-
-会调用每个插件的  方法
-