plugin-tls 0.0.0 → 1.1.0

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [createPropertySetter](./plugin-tls.createpropertysetter.md)
+
+## createPropertySetter() function
+
+创建属性设置器
+
+**Signature:**
+
+```typescript
+export declare function createPropertySetter(target: any, props: any): {
+    set: () => void;
+    unset: () => void;
+};
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | any |  |
+|  props | any |  |
+
+**Returns:**
+
+{ set: () =&gt; void; unset: () =&gt; void; }
+
+会返回一个 set 和 unset 方法，set 方法用户将 props 中描述的属性值设置到 target 中， unset 方法用于恢复成原来的值
+

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [createTargetExtend](./plugin-tls.createtargetextend.md)
+
+## createTargetExtend() function
+
+创建用于扩展目标的便捷函数
+
+**Signature:**
+
+```typescript
+export declare function createTargetExtend<C extends ClassType>(cla: C): <E>(ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtend<C>) => E & ThisType<C & E>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，也用作 this 的类型 |
+
+**Returns:**
+
+&lt;E&gt;(ext: E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)<!-- -->&lt;C&gt;) =&gt; E &amp; ThisType&lt;C &amp; E&gt;
+
+可以用于 扩展目标 的便利函数
+
+## Remarks
+
+它返回的便利函数的功能与 [targetExtend()](./plugin-tls.targetextend.md) 的功能一样，唯一区别是不再需要接收 cla 参数了
+

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [createTargetExtendWithInit](./plugin-tls.createtargetextendwithinit.md)
+
+## createTargetExtendWithInit() function
+
+创建用于扩展目标的便捷函数
+
+**Signature:**
+
+```typescript
+export declare function createTargetExtendWithInit<C extends ClassType>(cla: C): <E>(ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtendWithInit<C, any>) => E & ThisType<C & E>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，也用作 this 的类型 |
+
+**Returns:**
+
+&lt;E&gt;(ext: E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md)<!-- -->&lt;C, any&gt;) =&gt; E &amp; ThisType&lt;C &amp; E&gt;
+
+可以用于 扩展目标 的便利函数
+
+## Remarks
+
+它返回的便利函数的功能与 [targetExtendWithInit()](./plugin-tls.targetextendwithinit.md) 的功能一样，唯一区别是不再需要接收 cla 参数了
+

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [createTargetMixin](./plugin-tls.createtargetmixin.md)
+
+## createTargetMixin() function
+
+创建用于混合目标的便捷函数
+
+**Signature:**
+
+```typescript
+export declare function createTargetMixin<T>(target: T): <M>(m: M & ThisType<T & M>) => M & ThisType<T & M>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | T | 混合的目标，用作 this 的类型 |
+
+**Returns:**
+
+&lt;M&gt;(m: M &amp; ThisType&lt;T &amp; M&gt;) =&gt; M &amp; ThisType&lt;T &amp; M&gt;
+
+可以用于 混合目标 的便利函数
+
+## Remarks
+
+它返回的便利函数的功能与 [targetMixin()](./plugin-tls.targetmixin.md) 的功能一样，唯一区别是不再需要接收 target 参数了
+

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

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [createTierModeOptionsPluginHost](./plugin-tls.createtiermodeoptionspluginhost.md)
+
+## createTierModeOptionsPluginHost() function
+
+创建带有选项机制的插件宿主类  比 直接使用 ModeOptionsPluginHost 提供了完善的类型推导
+
+**Signature:**
+
+```typescript
+export declare function createTierModeOptionsPluginHost<HOST, Options extends {}, Mode extends string | number = string>(): {
+    new (options: Options): {
+        readonly modeOptions: TierModeOptions<Mode, Options>;
+        _modeOptions: TierModeOptions<Mode, Options>;
+        mode: Mode;
+        readonly options: Options;
+        readonly pluginManager: import("..").PluginManager<any, import("..").IPlugin<any, any>>;
+        use<P extends import("..").IPlugin<HOST, any>>(plugin: P, ...options: import("..").FormatUsePluginParameters<P>): void | import("..").PluginCreatedReturnType<P>;
+        destroy(): void;
+    };
+    readonly modeOptions: TierModeOptions<string, Options>;
+    readonly pluginManager: import("..").PluginManager<typeof import("./PluginHost").PluginHost & HOST, import("..").IPlugin<HOST, any>>;
+    _pluginManager: import("..").PluginManager<typeof import("./PluginHost").PluginHost & HOST, import("..").IPlugin<HOST, any>>;
+    use<P_1 extends import("..").IPlugin<HOST, any>>(plugin: P_1, ...options: import("..").FormatUsePluginParameters<P_1>): void | ReturnType<P_1["used"]>;
+};
+```
+**Returns:**
+
+{ new (options: Options): { readonly modeOptions: [TierModeOptions](./plugin-tls.tiermodeoptions.md)<!-- -->&lt;Mode, Options&gt;; \_modeOptions: [TierModeOptions](./plugin-tls.tiermodeoptions.md)<!-- -->&lt;Mode, Options&gt;; mode: Mode; readonly options: Options; readonly pluginManager: import("..").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;any, import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;any, any&gt;&gt;; use&lt;P extends import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;(plugin: P, ...options: import("..").[FormatUsePluginParameters](./plugin-tls.formatusepluginparameters.md)<!-- -->&lt;P&gt;): void \| import("..").[PluginCreatedReturnType](./plugin-tls.plugincreatedreturntype.md)<!-- -->&lt;P&gt;; destroy(): void; }; readonly modeOptions: [TierModeOptions](./plugin-tls.tiermodeoptions.md)<!-- -->&lt;string, Options&gt;; readonly pluginManager: import("..").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;typeof import("./PluginHost").[PluginHost](./plugin-tls.pluginhost.md) &amp; HOST, import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;; \_pluginManager: import("..").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;typeof import("./PluginHost").[PluginHost](./plugin-tls.pluginhost.md) &amp; HOST, import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;; use&lt;P\_1 extends import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;(plugin: P\_1, ...options: import("..").[FormatUsePluginParameters](./plugin-tls.formatusepluginparameters.md)<!-- -->&lt;P\_1&gt;): void \| ReturnType&lt;P\_1\["used"\]&gt;; }
+
+

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [createTierOptionsPluginHost](./plugin-tls.createtieroptionspluginhost.md)
+
+## createTierOptionsPluginHost() function
+
+创建带有选项机制的插件宿主类  比 直接使用 OptionsPluginHost 提供了完善的类型推导
+
+**Signature:**
+
+```typescript
+export declare function createTierOptionsPluginHost<HOST, Options extends {}>(): {
+    new (options: Options): {
+        readonly defaultOptions: TierOptions<Options>;
+        _defaultOptions: TierOptions<Options>;
+        readonly pluginManager: import("..").PluginManager<any, import("..").IPlugin<any, any>>;
+        use<P extends import("..").IPlugin<HOST, any>>(plugin: P, ...options: import("..").FormatUsePluginParameters<P>): void | import("..").PluginCreatedReturnType<P>;
+        destroy(): void;
+    };
+    readonly defaultOptions: TierOptions<Options>;
+    readonly pluginManager: import("..").PluginManager<typeof import("./PluginHost").PluginHost & HOST, import("..").IPlugin<HOST, any>>;
+    _pluginManager: import("..").PluginManager<typeof import("./PluginHost").PluginHost & HOST, import("..").IPlugin<HOST, any>>;
+    use<P_1 extends import("..").IPlugin<HOST, any>>(plugin: P_1, ...options: import("..").FormatUsePluginParameters<P_1>): void | ReturnType<P_1["used"]>;
+};
+```
+**Returns:**
+
+{ new (options: Options): { readonly defaultOptions: [TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Options&gt;; \_defaultOptions: [TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Options&gt;; readonly pluginManager: import("..").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;any, import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;any, any&gt;&gt;; use&lt;P extends import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;(plugin: P, ...options: import("..").[FormatUsePluginParameters](./plugin-tls.formatusepluginparameters.md)<!-- -->&lt;P&gt;): void \| import("..").[PluginCreatedReturnType](./plugin-tls.plugincreatedreturntype.md)<!-- -->&lt;P&gt;; destroy(): void; }; readonly defaultOptions: [TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Options&gt;; readonly pluginManager: import("..").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;typeof import("./PluginHost").[PluginHost](./plugin-tls.pluginhost.md) &amp; HOST, import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;; \_pluginManager: import("..").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;typeof import("./PluginHost").[PluginHost](./plugin-tls.pluginhost.md) &amp; HOST, import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;; use&lt;P\_1 extends import("..").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, any&gt;&gt;(plugin: P\_1, ...options: import("..").[FormatUsePluginParameters](./plugin-tls.formatusepluginparameters.md)<!-- -->&lt;P\_1&gt;): void \| ReturnType&lt;P\_1\["used"\]&gt;; }
+
+

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

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [defineExtend](./plugin-tls.defineextend.md)
+
+## defineExtend() function
+
+定义扩展的类型便利函数
+
+**Signature:**
+
+```typescript
+export declare function defineExtend<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtend<C>): E & ThisType<C & E>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，用作 this 的类型 |
+|  ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)<!-- -->&lt;C&gt; | 描述扩展内容的对象，会自动更改其this的类型 |
+
+**Returns:**
+
+E &amp; ThisType&lt;C &amp; E&gt;
+
+返回注入了 this 类型的 ext 对象本身
+
+## Remarks
+
+它会更改 ext 中方法的this指向为 cla &amp; ext，不会真的执行扩展操作。
+
+其中 ext.\_constructor 会被保存在 cla.\_constructors 属性中，它是一个数组。
+
+cla 需要在自己的构建函数中逐个调用 cla.\_constructors 中的函数
+

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

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [defineExtendWithInit](./plugin-tls.defineextendwithinit.md)
+
+## defineExtendWithInit() function
+
+定义扩展的类型便利函数
+
+**Signature:**
+
+```typescript
+export declare function defineExtendWithInit<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtendWithInit<C>): E & ThisType<C & E>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，用作 this 的类型 |
+|  ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md)<!-- -->&lt;C&gt; | 描述扩展内容的对象，会自动更改其this的类型 |
+
+**Returns:**
+
+E &amp; ThisType&lt;C &amp; E&gt;
+
+返回注入了 this 类型的 ext 对象本身
+
+## Remarks
+
+它会更改 ext 中方法的this指向为 cla &amp; ext，不会真的执行扩展操作。
+
+其中： - ext.\_constructor 会被保存在 cla.\_constructors 属性中，它是一个数组。 - ext.\_init 会被保存在 cla.\_inits 属性中，它是一个数组。
+
+cla 需要： - 在自己的构建函数中逐个调用 cla.\_constructors 中的函数 - 在自己的类似初始化`init()` 方法中逐个调用 cla.\_constructors 中的函数
+

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

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [defineMixin](./plugin-tls.definemixin.md)
+
+## defineMixin() function
+
+定义混合的类型便利函数
+
+**Signature:**
+
+```typescript
+export declare function defineMixin<T, M>(target: T, mixin: M & ThisType<T & M>): M & ThisType<T & M>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | T | 混合的目标，用作 this 的类型 |
+|  mixin | M &amp; ThisType&lt;T &amp; M&gt; | 混合对象，会自动更改其this的类型 |
+
+**Returns:**
+
+M &amp; ThisType&lt;T &amp; M&gt;
+
+返回注入了 this 类型的 mixin 对象本身
+
+## Remarks
+
+它会更改 mixin 中方法的this指向为 target &amp; mixin，不会真的执行混合操作
+

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

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [extendTarget](./plugin-tls.extendtarget.md)
+
+## extendTarget() function
+
+扩展目标
+
+**Signature:**
+
+```typescript
+export declare function extendTarget<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtend<C>): ClassType<ConstructorParameters<C>, E & ThisType<InstanceType<C> & E>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，也用作 this 的类型 |
+|  ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)<!-- -->&lt;C&gt; | 扩展对象，会自动更改其this的类型 |
+
+**Returns:**
+
+[ClassType](./plugin-tls.classtype.md)<!-- -->&lt;ConstructorParameters&lt;C&gt;, E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt;&gt;
+
+返回扩展后的 cla 对象
+
+## Remarks
+
+会执行对 CEarth 类的扩展操作。 与 [targetExtend()](./plugin-tls.targetextend.md) 的区别仅仅是返回类型不一样。
+

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

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [extendTargetWithInit](./plugin-tls.extendtargetwithinit.md)
+
+## extendTargetWithInit() function
+
+扩展目标
+
+**Signature:**
+
+```typescript
+export declare function extendTargetWithInit<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtendWithInit<C>): ClassType<ConstructorParameters<C>, E & ThisType<InstanceType<C> & E>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cla | C | 扩展的目标，也用作 this 的类型 |
+|  ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md)<!-- -->&lt;C&gt; | 扩展对象，会自动更改其this的类型 |
+
+**Returns:**
+
+[ClassType](./plugin-tls.classtype.md)<!-- -->&lt;ConstructorParameters&lt;C&gt;, E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt;&gt;
+
+返回扩展后的 cla 对象
+
+## Remarks
+
+会执行对 CEarth 类的扩展操作。 与 [targetExtendWithInit()](./plugin-tls.targetextendwithinit.md) 的区别仅仅是返回类型不一样。
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [FormatUseParameters](./plugin-tls.formatuseparameters.md)
+
+## FormatUseParameters type
+
+格式化 use 方法的参数列表
+
+**Signature:**
+
+```typescript
+export type FormatUseParameters<Options> = Options extends never | void | undefined ? [] : [Options];
+```

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [FormatUsePluginParameters](./plugin-tls.formatusepluginparameters.md)
+
+## FormatUsePluginParameters type
+
+格式化 use 方法的参数列表
+
+**Signature:**
+
+```typescript
+export type FormatUsePluginParameters<Plugin> = GetPluginOptions<Plugin> extends never | void | undefined ? [] : [GetPluginOptions<Plugin>];
+```
+**References:** [GetPluginOptions](./plugin-tls.getpluginoptions.md)
+

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [GetNormalizePluginOptions](./plugin-tls.getnormalizepluginoptions.md)
+
+## GetNormalizePluginOptions type
+
+获取规范化的插件选项
+
+**Signature:**
+
+```typescript
+export type GetNormalizePluginOptions<Plugin> = NormalizePluginOptions<GetPluginOptions<Plugin>>;
+```
+**References:** [NormalizePluginOptions](./plugin-tls.normalizepluginoptions.md)<!-- -->, [GetPluginOptions](./plugin-tls.getpluginoptions.md)
+

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [GetPluginOptions](./plugin-tls.getpluginoptions.md)
+
+## GetPluginOptions type
+
+获取插件的选项类型
+
+**Signature:**
+
+```typescript
+export type GetPluginOptions<Plugin> = Plugin extends IPlugin<any, infer Options> ? Options : never;
+```
+**References:** [IPlugin](./plugin-tls.iplugin.md)
+

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [getPropertyValue](./plugin-tls.getpropertyvalue.md)
+
+## getPropertyValue() function
+
+通过key列表获取对象中对应属性的值
+
+**Signature:**
+
+```typescript
+export declare function getPropertyValue(obj: any, props: string[]): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  obj | any |  |
+|  props | string\[\] |  |
+
+**Returns:**
+
+any
+
+

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [getPropertyValueByPath](./plugin-tls.getpropertyvaluebypath.md)
+
+## getPropertyValueByPath() function
+
+获取对象的属性路径对应的属性值
+
+**Signature:**
+
+```typescript
+export declare function getPropertyValueByPath(obj: any, propPath: string): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  obj | any |  |
+|  propPath | string |  |
+
+**Returns:**
+
+any
+
+

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [getTargetProperties](./plugin-tls.gettargetproperties.md)
+
+## getTargetProperties() function
+
+按照 props 的结构，获取 target 的 属性对象 - props 中所有 纯对象 都会被作为 props 进行递归地获取
+
+**Signature:**
+
+```typescript
+export declare function getTargetProperties<Props>(target: any, props: Props): Props;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | any |  |
+|  props | Props |  |
+
+**Returns:**
+
+Props
+
+

package/doc/{plugin-tls.hostinst.md → api/plugin-tls.hostinst.md}

@@ -6,8 +6,8 @@
 
 插件宿主的实例类型
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
-export declare type HostInst<H> = H extends new (...args: any) => any ? InstanceType<H> : H;
+export type HostInst<H> = H extends new (...args: any) => any ? InstanceType<H> : H;
 ```

package/doc/{plugin-tls.idefaultoptionshost.defaultoptions.md → api/plugin-tls.idefaultoptionshost.defaultoptions.md}

@@ -4,7 +4,7 @@
 
 ## IDefaultOptionsHost.defaultOptions property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 readonly defaultOptions: Options;

package/doc/{plugin-tls.idefaultoptionshost.md → api/plugin-tls.idefaultoptionshost.md}

@@ -6,7 +6,7 @@
 
 默认选项宿主接口
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface IDefaultOptionsHost<Options> 

package/doc/{plugin-tls.iidefaultoptionshostconstructor.md → api/plugin-tls.iidefaultoptionshostconstructor.md}

@@ -6,7 +6,7 @@
 
 默认选项宿主的构建函数接口
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface IIDefaultOptionsHostConstructor<Options> 

package/doc/{plugin-tls.iplugin.created.md → api/plugin-tls.iplugin.created.md}

@@ -6,10 +6,10 @@
 
 当宿主实例被创建时调用
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
-created?(host: HostInst<HOST>, options?: Options): any;
+created?(host: HostInst<HOST>, ...options: FormatUseParameters<Options>): any;
 ```
 
 ## Parameters
@@ -17,9 +17,9 @@ created?(host: HostInst<HOST>, options?: Options): any;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  host | [HostInst](./plugin-tls.hostinst.md)<!-- -->&lt;HOST&gt; | 新建的宿主实例 |
-|  options | Options | <i>(Optional)</i> 注册插件时的选项 |
+|  options | [FormatUseParameters](./plugin-tls.formatuseparameters.md)<!-- -->&lt;Options&gt; | 注册插件时的选项 |
 
-<b>Returns:</b>
+**Returns:**
 
 any
 

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [IPlugin](./plugin-tls.iplugin.md) &gt; [destroyed](./plugin-tls.iplugin.destroyed.md)
+
+## IPlugin.destroyed() method
+
+当宿主实例被销毁时调用
+
+**Signature:**
+
+```typescript
+destroyed?(host: HostInst<HOST>, ...options: FormatUseParameters<Options>): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  host | [HostInst](./plugin-tls.hostinst.md)<!-- -->&lt;HOST&gt; | 被销毁的宿主实例 |
+|  options | [FormatUseParameters](./plugin-tls.formatuseparameters.md)<!-- -->&lt;Options&gt; | 注册插件时的选项 |
+
+**Returns:**
+
+any
+

package/doc/{plugin-tls.iplugin.md → api/plugin-tls.iplugin.md}

@@ -6,16 +6,17 @@
 
 插件的接口
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
-export interface IPlugin<HOST, Options = any> 
+export interface IPlugin<HOST, Options = void> 
 ```
 
 ## Methods
 
 |  Method | Description |
 |  --- | --- |
-|  [created(host, options)?](./plugin-tls.iplugin.created.md) | <i>(Optional)</i> 当宿主实例被创建时调用 |
+|  [created(host, options)?](./plugin-tls.iplugin.created.md) | _(Optional)_ 当宿主实例被创建时调用 |
+|  [destroyed(host, options)?](./plugin-tls.iplugin.destroyed.md) | _(Optional)_ 当宿主实例被销毁时调用 |
 |  [used(Host, options)](./plugin-tls.iplugin.used.md) | 当插件被注册时调用 |
 

package/doc/{plugin-tls.iplugin.used.md → api/plugin-tls.iplugin.used.md}

@@ -6,10 +6,10 @@
 
 当插件被注册时调用
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
-used(Host: HOST, options?: Options): any;
+used(Host: HOST, ...options: FormatUseParameters<Options>): any;
 ```
 
 ## Parameters
@@ -17,9 +17,9 @@ used(Host: HOST, options?: Options): any;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  Host | HOST | 宿主的类型 |
-|  options | Options | <i>(Optional)</i> 注册插件时的选项 |
+|  options | [FormatUseParameters](./plugin-tls.formatuseparameters.md)<!-- -->&lt;Options&gt; | 注册插件时的选项 |
 
-<b>Returns:</b>
+**Returns:**
 
 any