npm - plugin-tls - Versions diffs - 3.3.3 → 3.5.0 - Mend

plugin-tls 3.3.3 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (163) hide show

package/doc/api/plugin-tls.pluginmanager.md DELETED Viewed

@@ -1,214 +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)
-## PluginManager class
-插件管理者
-**Signature:**
-```typescript
-export declare class PluginManager<HostClassType, Plugin extends IPlugin<HostClassType, any> = IPlugin<HostClassType, any>>
-```
-## Remarks
-负责管理插件的注册、应用 等
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(host)](./plugin-tls.pluginmanager._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `PluginManager` class
-</td></tr>
-</tbody></table>
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[host](./plugin-tls.pluginmanager.host.md)
-</td><td>
-</td><td>
-HostClassType
-</td><td>
-插件的宿主
-</td></tr>
-<tr><td>
-[pluginOptsMap](./plugin-tls.pluginmanager.pluginoptsmap.md)
-</td><td>
-`readonly`
-</td><td>
-Map&lt;Plugin, any&gt;
-</td><td>
-插件与插件选项的映射
-</td></tr>
-<tr><td>
-[plugins](./plugin-tls.pluginmanager.plugins.md)
-</td><td>
-`readonly`
-</td><td>
-Plugin\[\]
-</td><td>
-注册的插件
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[created(hostInst)](./plugin-tls.pluginmanager.created.md)
-</td><td>
-</td><td>
-插件宿主创建实例时调用
-</td></tr>
-<tr><td>
-[destroyed(hostInst)](./plugin-tls.pluginmanager.destroyed.md)
-</td><td>
-</td><td>
-插件宿主被销毁时调用
-</td></tr>
-<tr><td>
-[instUse(hostInst, plugin, options)](./plugin-tls.pluginmanager.instuse.md)
-</td><td>
-</td><td>
-插件宿主实例的注册插件的方法
-</td></tr>
-<tr><td>
-[use(plugin, options)](./plugin-tls.pluginmanager.use.md)
-</td><td>
-</td><td>
-使用插件、注册插件
-</td></tr>
-</tbody></table>

package/doc/api/plugin-tls.pluginmanager.pluginoptsmap.md DELETED Viewed

@@ -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; [pluginOptsMap](./plugin-tls.pluginmanager.pluginoptsmap.md)
-## PluginManager.pluginOptsMap property
-插件与插件选项的映射
-**Signature:**
-```typescript
-readonly pluginOptsMap: Map<Plugin, any>;
-```

package/doc/api/plugin-tls.pluginmanager.plugins.md DELETED Viewed

@@ -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; [plugins](./plugin-tls.pluginmanager.plugins.md)
-## PluginManager.plugins property
-注册的插件
-**Signature:**
-```typescript
-readonly plugins: Plugin[];
-```

package/doc/api/plugin-tls.pluginmanager.use.md DELETED Viewed

@@ -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; [PluginManager](./plugin-tls.pluginmanager.md) &gt; [use](./plugin-tls.pluginmanager.use.md)
-## PluginManager.use() method
-使用插件、注册插件
-**Signature:**
-```typescript
-use<P extends Plugin>(plugin: P, ...options: FormatUsePluginParameters<P>): PluginUseReturnType<P> | void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><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:**
-[PluginUseReturnType](./plugin-tls.pluginusereturntype.md)<!-- -->&lt;P&gt; \| void

package/doc/api/plugin-tls.pluginmanagerwithinit.inited.md DELETED Viewed

@@ -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; [PluginManagerWithInit](./plugin-tls.pluginmanagerwithinit.md) &gt; [inited](./plugin-tls.pluginmanagerwithinit.inited.md)
-## PluginManagerWithInit.inited() method
-插件宿主创建实例时调用
-**Signature:**
-```typescript
-inited(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.pluginmanagerwithinit.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManagerWithInit](./plugin-tls.pluginmanagerwithinit.md)
-## PluginManagerWithInit class
-插件管理者
-**Signature:**
-```typescript
-export declare class PluginManagerWithInit<HostClassType, Plugin extends IPluginWithInit<HostClassType, any> = IPluginWithInit<HostClassType, any>> extends PluginManager<HostClassType, Plugin>
-```
-**Extends:** [PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;HostClassType, Plugin&gt;
-## Remarks
-负责管理插件的注册、应用 等
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[inited(hostInst)](./plugin-tls.pluginmanagerwithinit.inited.md)
-</td><td>
-</td><td>
-插件宿主创建实例时调用
-</td></tr>
-</tbody></table>

package/doc/api/plugin-tls.pluginusereturntype.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginUseReturnType](./plugin-tls.pluginusereturntype.md)
-## PluginUseReturnType type
-插件的 used 方法的返回值类型
-**Signature:**
-```typescript
-export type PluginUseReturnType<P extends IPlugin<any, any>> = ReturnType<P["used"]>;
-```
-**References:** [IPlugin](./plugin-tls.iplugin.md)

package/doc/api/plugin-tls.privatememberofextend._constructor.md DELETED Viewed

@@ -1,60 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md) &gt; [\_constructor](./plugin-tls.privatememberofextend._constructor.md)
-## PrivateMemberOfExtend.\_constructor() method
-扩展类中用于定义在创建实例时的初始化的方法
-**Signature:**
-```typescript
-_constructor?(...args: (TargetType extends new (...args: infer A) => any ? A : never)): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-args
-</td><td>
-(TargetType extends new (...args: infer A) =&gt; any ? A : never)
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void
-## Remarks
-该方法会在创建实例时自动执行，并将构建函数接收到的参数透传给方方法。
-注意： \_constructor 会被保存在 目标类中的 \_constructors 属性中，它是一个数组。
-目标类 需要在自己的构建函数中逐个调用 cla.\_constructors 中的函数

package/doc/api/plugin-tls.privatememberofextend._destroy.md DELETED Viewed

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md) &gt; [\_destroy](./plugin-tls.privatememberofextend._destroy.md)
-## PrivateMemberOfExtend.\_destroy() method
-扩展类中用于定义在实例销毁时触发的销毁方法
-**Signature:**
-```typescript
-_destroy?(): void;
-```
-**Returns:**
-void
-## Remarks
-该方法会在实例销毁时自动调用
-注意： \_destroy 会被保存在 目标类中的 \_destroys 属性中，它是一个数组。
-如果目标类有销毁逻辑，则需要在自己的销毁函数中逐个调用 cla.\_destroys 中的函数

package/doc/api/plugin-tls.privatememberofextend.md DELETED Viewed

@@ -1,51 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)
-## PrivateMemberOfExtend interface
-用于定义扩展选项中的私有成员
-**Signature:**
-```typescript
-export interface PrivateMemberOfExtend<TargetType extends new (...args: any) => Object>
-```
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[\_constructor(args)?](./plugin-tls.privatememberofextend._constructor.md)
-</td><td>
-_(Optional)_ 扩展类中用于定义在创建实例时的初始化的方法
-</td></tr>
-<tr><td>
-[\_destroy()?](./plugin-tls.privatememberofextend._destroy.md)
-</td><td>
-_(Optional)_ 扩展类中用于定义在实例销毁时触发的销毁方法
-</td></tr>
-</tbody></table>

package/doc/api/plugin-tls.privatememberofextendwithinit._init.md DELETED Viewed

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md) &gt; [\_init](./plugin-tls.privatememberofextendwithinit._init.md)
-## PrivateMemberOfExtendWithInit.\_init() method
-扩展类中用于定义实例初始化逻辑的方法
-**Signature:**
-```typescript
-_init?(...args: InitParams): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-args
-</td><td>
-InitParams
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void
-## Remarks
-该方法会在调用实例的 `init()` 方法时自动执行。

package/doc/api/plugin-tls.privatememberofextendwithinit.md DELETED Viewed

@@ -1,41 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md)
-## PrivateMemberOfExtendWithInit interface
-用于定义扩展选项中的私有成员
-**Signature:**
-```typescript
-export interface PrivateMemberOfExtendWithInit<TargetType extends new (...args: any) => Object, InitParams extends any[] = any> extends PrivateMemberOfExtend<TargetType>
-```
-**Extends:** [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)<!-- -->&lt;TargetType&gt;
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[\_init(args)?](./plugin-tls.privatememberofextendwithinit._init.md)
-</td><td>
-_(Optional)_ 扩展类中用于定义实例初始化逻辑的方法
-</td></tr>
-</tbody></table>

package/doc/api/plugin-tls.replaceconstructorparameters.md DELETED Viewed

@@ -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; [ReplaceConstructorParameters](./plugin-tls.replaceconstructorparameters.md)
-## ReplaceConstructorParameters type
-替换构建函数的参数
-**Signature:**
-```typescript
-export type ReplaceConstructorParameters<C extends new (...args: any) => any, NewParms extends any[]> = new (...args: NewParms) => InstanceType<C>;
-```

package/doc/api/plugin-tls.replaceconstructorreturn.md DELETED Viewed

@@ -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; [ReplaceConstructorReturn](./plugin-tls.replaceconstructorreturn.md)
-## ReplaceConstructorReturn type
-替换构造函数的返回类型
-**Signature:**
-```typescript
-export type ReplaceConstructorReturn<C extends new (...args: any) => any, NewReturn> = new (...args: ConstructorParameters<C>) => NewReturn;
-```