plugin-tls 0.0.0 → 1.1.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 (210) hide show
  1. package/README.md +5 -5
  2. package/dist/extend/extend.d.ts +222 -0
  3. package/dist/extend/extend.d.ts.map +1 -0
  4. package/dist/extend/mixin.d.ts +105 -0
  5. package/dist/extend/mixin.d.ts.map +1 -0
  6. package/dist/index.d.ts +14 -4
  7. package/dist/index.d.ts.map +1 -0
  8. package/dist/options-manager/ModeOptions.d.ts +88 -0
  9. package/dist/options-manager/ModeOptions.d.ts.map +1 -0
  10. package/dist/options-manager/OptionsManager.d.ts +105 -0
  11. package/dist/options-manager/OptionsManager.d.ts.map +1 -0
  12. package/dist/options-manager/TierModeOptions.d.ts +69 -0
  13. package/dist/options-manager/TierModeOptions.d.ts.map +1 -0
  14. package/dist/options-manager/TierOptions.d.ts +48 -0
  15. package/dist/options-manager/TierOptions.d.ts.map +1 -0
  16. package/dist/{defaultOptions.d.ts → options-manager/defaultOptions.d.ts} +2 -1
  17. package/dist/options-manager/defaultOptions.d.ts.map +1 -0
  18. package/dist/options-manager/tools.d.ts +35 -0
  19. package/dist/options-manager/tools.d.ts.map +1 -0
  20. package/dist/plugin-host/PluginHost.d.ts +184 -0
  21. package/dist/plugin-host/PluginHost.d.ts.map +1 -0
  22. package/dist/plugin-host/TierModeOptionsPluginHost.d.ts +102 -0
  23. package/dist/plugin-host/TierModeOptionsPluginHost.d.ts.map +1 -0
  24. package/dist/plugin-host/TierOptionsPluginHost.d.ts +83 -0
  25. package/dist/plugin-host/TierOptionsPluginHost.d.ts.map +1 -0
  26. package/dist/plugin-manager/PluginManager.d.ts +119 -0
  27. package/dist/plugin-manager/PluginManager.d.ts.map +1 -0
  28. package/dist/plugin-manager/PluginManagerWithInit.d.ts +36 -0
  29. package/dist/plugin-manager/PluginManagerWithInit.d.ts.map +1 -0
  30. package/dist/plugin-tls.d.ts +1329 -0
  31. package/dist/plugin-tls.iife.js +1 -0
  32. package/dist/plugin-tls.mjs +1064 -0
  33. package/dist/plugin-tls.umd.js +1 -1
  34. package/dist/properties.d.ts +30 -0
  35. package/dist/properties.d.ts.map +1 -0
  36. package/dist/tsdoc-metadata.json +11 -0
  37. package/doc/{plugin-tls.adddefaultoptions.md → api/plugin-tls.adddefaultoptions.md} +3 -3
  38. package/doc/{plugin-tls.addinstoptions.md → api/plugin-tls.addinstoptions.md} +2 -2
  39. package/doc/api/plugin-tls.allfunctionapply.md +26 -0
  40. package/doc/api/plugin-tls.becomepluginhost.md +15 -0
  41. package/doc/api/plugin-tls.becomepluginhost_extends.md +38 -0
  42. package/doc/api/plugin-tls.becomepluginhost_proxy.md +29 -0
  43. package/doc/api/plugin-tls.becometiermodeoptionshost.md +15 -0
  44. package/doc/api/plugin-tls.becometieroptionshost.md +15 -0
  45. package/doc/api/plugin-tls.classextender.md +15 -0
  46. package/doc/api/plugin-tls.classextenderprivatemember._constructors.md +13 -0
  47. package/doc/api/plugin-tls.classextenderprivatemember._destroys.md +13 -0
  48. package/doc/api/plugin-tls.classextenderprivatemember.md +21 -0
  49. package/doc/api/plugin-tls.classextenderprivatememberwithinit._inits.md +13 -0
  50. package/doc/api/plugin-tls.classextenderprivatememberwithinit.md +21 -0
  51. package/doc/api/plugin-tls.classextenderwithinit.md +15 -0
  52. package/doc/api/plugin-tls.classtype._new_.md +22 -0
  53. package/doc/api/plugin-tls.classtype.md +20 -0
  54. package/doc/api/plugin-tls.commonmodename.md +18 -0
  55. package/doc/api/plugin-tls.createcallerofprivatememberofextend.md +30 -0
  56. package/doc/api/plugin-tls.createdefinemixin.md +23 -0
  57. package/doc/api/plugin-tls.createextendtarget.md +30 -0
  58. package/doc/api/plugin-tls.createextendtargetwithinit.md +30 -0
  59. package/doc/api/plugin-tls.createmixintarget.md +30 -0
  60. package/doc/api/plugin-tls.createpluginhost.md +35 -0
  61. package/doc/api/plugin-tls.createpropertysetter.md +30 -0
  62. package/doc/api/plugin-tls.createtargetextend.md +30 -0
  63. package/doc/api/plugin-tls.createtargetextendwithinit.md +30 -0
  64. package/doc/api/plugin-tls.createtargetmixin.md +30 -0
  65. package/doc/api/plugin-tls.createtiermodeoptionspluginhost.md +32 -0
  66. package/doc/api/plugin-tls.createtieroptionspluginhost.md +30 -0
  67. package/doc/api/plugin-tls.defineextend.md +35 -0
  68. package/doc/api/plugin-tls.defineextendwithinit.md +35 -0
  69. package/doc/api/plugin-tls.definemixin.md +31 -0
  70. package/doc/api/plugin-tls.extendtarget.md +31 -0
  71. package/doc/api/plugin-tls.extendtargetwithinit.md +31 -0
  72. package/doc/api/plugin-tls.formatuseparameters.md +13 -0
  73. package/doc/api/plugin-tls.formatusepluginparameters.md +15 -0
  74. package/doc/api/plugin-tls.getnormalizepluginoptions.md +15 -0
  75. package/doc/api/plugin-tls.getpluginoptions.md +15 -0
  76. package/doc/api/plugin-tls.getpropertyvalue.md +26 -0
  77. package/doc/api/plugin-tls.getpropertyvaluebypath.md +26 -0
  78. package/doc/api/plugin-tls.gettargetproperties.md +26 -0
  79. package/doc/{plugin-tls.hostinst.md → api/plugin-tls.hostinst.md} +2 -2
  80. package/doc/{plugin-tls.idefaultoptionshost.defaultoptions.md → api/plugin-tls.idefaultoptionshost.defaultoptions.md} +1 -1
  81. package/doc/{plugin-tls.idefaultoptionshost.md → api/plugin-tls.idefaultoptionshost.md} +1 -1
  82. package/doc/{plugin-tls.iidefaultoptionshostconstructor.md → api/plugin-tls.iidefaultoptionshostconstructor.md} +1 -1
  83. package/doc/{plugin-tls.iplugin.created.md → api/plugin-tls.iplugin.created.md} +4 -4
  84. package/doc/api/plugin-tls.iplugin.destroyed.md +25 -0
  85. package/doc/{plugin-tls.iplugin.md → api/plugin-tls.iplugin.md} +4 -3
  86. package/doc/{plugin-tls.iplugin.used.md → api/plugin-tls.iplugin.used.md} +4 -4
  87. package/doc/{plugin-tls.ipluginhost.md → api/plugin-tls.ipluginhost.md} +2 -2
  88. package/doc/{plugin-tls.ipluginhost.use.md → api/plugin-tls.ipluginhost.use.md} +6 -6
  89. package/doc/{plugin-tls.ipluginhostconstructor.md → api/plugin-tls.ipluginhostconstructor.md} +2 -2
  90. package/doc/{plugin-tls.ipluginhostconstructor.use.md → api/plugin-tls.ipluginhostconstructor.use.md} +6 -6
  91. package/doc/api/plugin-tls.ipluginwithinit.inited.md +25 -0
  92. package/doc/api/plugin-tls.ipluginwithinit.md +21 -0
  93. package/doc/api/plugin-tls.itiermodeoptionshost.md +21 -0
  94. package/doc/api/plugin-tls.itiermodeoptionshost.mode.md +11 -0
  95. package/doc/api/plugin-tls.itiermodeoptionshost.modeoptions.md +11 -0
  96. package/doc/api/plugin-tls.itiermodeoptionshostconstructor.md +13 -0
  97. package/doc/api/plugin-tls.itiermodeoptionspluginhost.md +15 -0
  98. package/doc/api/plugin-tls.itiermodeoptionspluginhostconstructor.md +15 -0
  99. package/doc/api/plugin-tls.itieroptionshost.defaultoptions.md +11 -0
  100. package/doc/api/plugin-tls.itieroptionshost.md +20 -0
  101. package/doc/api/plugin-tls.itieroptionshostconstructor.md +13 -0
  102. package/doc/api/plugin-tls.itieroptionspluginhost.md +15 -0
  103. package/doc/api/plugin-tls.itieroptionspluginhostconstructor.md +15 -0
  104. package/doc/api/plugin-tls.md +121 -0
  105. package/doc/api/plugin-tls.mergeproperties.md +25 -0
  106. package/doc/api/plugin-tls.mixin_4.md +33 -0
  107. package/doc/api/plugin-tls.mixintarget.md +31 -0
  108. package/doc/api/plugin-tls.modeoptions._constructor_.md +20 -0
  109. package/doc/api/plugin-tls.modeoptions._constructor__1.md +21 -0
  110. package/doc/api/plugin-tls.modeoptions._mode.md +11 -0
  111. package/doc/api/plugin-tls.modeoptions._modenames.md +11 -0
  112. package/doc/api/plugin-tls.modeoptions._plainfulloption.md +11 -0
  113. package/doc/api/plugin-tls.modeoptions.getfullmodeoption.md +29 -0
  114. package/doc/api/plugin-tls.modeoptions.getmodenames.md +18 -0
  115. package/doc/api/plugin-tls.modeoptions.getmodeoption.md +29 -0
  116. package/doc/api/plugin-tls.modeoptions.hasmode.md +25 -0
  117. package/doc/api/plugin-tls.modeoptions.md +57 -0
  118. package/doc/api/plugin-tls.modeoptions.mode.md +15 -0
  119. package/doc/api/plugin-tls.modeoptions.modenames.md +13 -0
  120. package/doc/api/plugin-tls.modeoptions.modes.md +13 -0
  121. package/doc/api/plugin-tls.modeoptions.option.md +13 -0
  122. package/doc/api/plugin-tls.modeoptions.optionmanager.md +13 -0
  123. package/doc/api/plugin-tls.modeoptions.plainfulloption.md +11 -0
  124. package/doc/api/plugin-tls.modeoptions.setmodeoption.md +27 -0
  125. package/doc/api/plugin-tls.modeoptions.updatefulloption.md +17 -0
  126. package/doc/api/plugin-tls.normalizepluginoptions.md +18 -0
  127. package/doc/api/plugin-tls.parsepropertypath.md +25 -0
  128. package/doc/{plugin-tls.plugincreatedreturntype.md → api/plugin-tls.plugincreatedreturntype.md} +3 -3
  129. package/doc/{plugin-tls.pluginhost._pluginmanager.md → api/plugin-tls.pluginhost._pluginmanager.md} +2 -2
  130. package/doc/api/plugin-tls.pluginhost.destroy.md +18 -0
  131. package/doc/api/plugin-tls.pluginhost.md +38 -0
  132. package/doc/{plugin-tls.pluginhost.pluginmanager.md → api/plugin-tls.pluginhost.pluginmanager.md} +2 -2
  133. package/doc/{plugin-tls.pluginhost.use.md → api/plugin-tls.pluginhost.use.md} +5 -5
  134. package/doc/api/plugin-tls.pluginmanager._constructor_.md +20 -0
  135. package/doc/{plugin-tls.pluginmanager.created.md → api/plugin-tls.pluginmanager.created.md} +4 -4
  136. package/doc/api/plugin-tls.pluginmanager.destroyed.md +28 -0
  137. package/doc/{plugin-tls.pluginmanager.host.md → api/plugin-tls.pluginmanager.host.md} +2 -2
  138. package/doc/api/plugin-tls.pluginmanager.instuse.md +30 -0
  139. package/doc/{plugin-tls.pluginmanager.md → api/plugin-tls.pluginmanager.md} +12 -5
  140. package/doc/{plugin-tls.pluginmanager.pluginoptsmap.md → api/plugin-tls.pluginmanager.pluginoptsmap.md} +2 -2
  141. package/doc/{plugin-tls.pluginmanager.plugins.md → api/plugin-tls.pluginmanager.plugins.md} +2 -2
  142. package/doc/{plugin-tls.pluginmanager.use.md → api/plugin-tls.pluginmanager.use.md} +6 -6
  143. package/doc/api/plugin-tls.pluginmanagerwithinit.inited.md +28 -0
  144. package/doc/api/plugin-tls.pluginmanagerwithinit.md +25 -0
  145. package/doc/{plugin-tls.pluginusereturntype.md → api/plugin-tls.pluginusereturntype.md} +3 -3
  146. package/doc/api/plugin-tls.privatememberofextend._constructor.md +32 -0
  147. package/doc/api/plugin-tls.privatememberofextend._destroy.md +25 -0
  148. package/doc/api/plugin-tls.privatememberofextend.md +21 -0
  149. package/doc/api/plugin-tls.privatememberofextendwithinit._init.md +28 -0
  150. package/doc/api/plugin-tls.privatememberofextendwithinit.md +21 -0
  151. package/doc/api/plugin-tls.replaceconstructorparameters.md +13 -0
  152. package/doc/api/plugin-tls.replaceconstructorreturn.md +13 -0
  153. package/doc/api/plugin-tls.setpropertyvalue.md +27 -0
  154. package/doc/api/plugin-tls.setpropertyvaluebypath.md +27 -0
  155. package/doc/api/plugin-tls.targetextend.md +31 -0
  156. package/doc/api/plugin-tls.targetextendwithinit.md +31 -0
  157. package/doc/api/plugin-tls.targetmixin.md +31 -0
  158. package/doc/api/plugin-tls.tiermodeoptions._constructor_.md +20 -0
  159. package/doc/api/plugin-tls.tiermodeoptions._constructor__1.md +22 -0
  160. package/doc/api/plugin-tls.tiermodeoptions._extends.md +11 -0
  161. package/doc/api/plugin-tls.tiermodeoptions.extends.md +15 -0
  162. package/doc/api/plugin-tls.tiermodeoptions.getfullmodeoption.md +29 -0
  163. package/doc/api/plugin-tls.tiermodeoptions.getmember.md +25 -0
  164. package/doc/api/plugin-tls.tiermodeoptions.getmodenames.md +18 -0
  165. package/doc/api/plugin-tls.tiermodeoptions.getmodeoptionmanager.md +25 -0
  166. package/doc/api/plugin-tls.tiermodeoptions.getvalue.md +25 -0
  167. package/doc/api/plugin-tls.tiermodeoptions.hasmodeontier.md +25 -0
  168. package/doc/api/plugin-tls.tiermodeoptions.md +45 -0
  169. package/doc/api/plugin-tls.tiermodeoptions.optionmanager.md +13 -0
  170. package/doc/api/plugin-tls.tiermodeoptionsdecorator.md +30 -0
  171. package/doc/api/plugin-tls.tiermodeoptionspluginhost._constructor_.md +20 -0
  172. package/doc/api/plugin-tls.tiermodeoptionspluginhost._modeoptions.md +11 -0
  173. package/doc/api/plugin-tls.tiermodeoptionspluginhost.md +37 -0
  174. package/doc/api/plugin-tls.tiermodeoptionspluginhost.mode.md +13 -0
  175. package/doc/api/plugin-tls.tiermodeoptionspluginhost.modeoptions.md +13 -0
  176. package/doc/api/plugin-tls.tiermodeoptionspluginhost.options.md +11 -0
  177. package/doc/api/plugin-tls.tieroptions._constructor_.md +21 -0
  178. package/doc/api/plugin-tls.tieroptions._extends.md +11 -0
  179. package/doc/api/plugin-tls.tieroptions._plainfulloption.md +11 -0
  180. package/doc/api/plugin-tls.tieroptions.extends.md +15 -0
  181. package/doc/api/plugin-tls.tieroptions.getmember.md +25 -0
  182. package/doc/api/plugin-tls.tieroptions.getvalue.md +25 -0
  183. package/doc/api/plugin-tls.tieroptions.md +37 -0
  184. package/doc/api/plugin-tls.tieroptions.option.md +13 -0
  185. package/doc/api/plugin-tls.tieroptions.plainfulloption.md +18 -0
  186. package/doc/api/plugin-tls.tieroptions.updatefulloption.md +17 -0
  187. package/doc/api/plugin-tls.tieroptionsdecorator.md +30 -0
  188. package/doc/api/plugin-tls.tieroptionspluginhost._constructor_.md +20 -0
  189. package/doc/api/plugin-tls.tieroptionspluginhost._defaultoptions.md +11 -0
  190. package/doc/api/plugin-tls.tieroptionspluginhost.defaultoptions.md +13 -0
  191. package/doc/api/plugin-tls.tieroptionspluginhost.md +35 -0
  192. package/package.json +23 -15
  193. package/dist/OptionsPluginHost.d.ts +0 -49
  194. package/dist/PluginHost.d.ts +0 -96
  195. package/dist/PluginManager.d.ts +0 -76
  196. package/dist/plugin-tls.es.js +0 -170
  197. package/doc/plugin-tls.createoptionspluginhost.md +0 -29
  198. package/doc/plugin-tls.createpluginhost.md +0 -30
  199. package/doc/plugin-tls.ioptionspluginhost.defaultoptions.md +0 -11
  200. package/doc/plugin-tls.ioptionspluginhost.md +0 -21
  201. package/doc/plugin-tls.ioptionspluginhostconstructor.md +0 -15
  202. package/doc/plugin-tls.md +0 -53
  203. package/doc/plugin-tls.optionspluginhost._defaultoptions.md +0 -11
  204. package/doc/plugin-tls.optionspluginhost.defaultoptions.md +0 -13
  205. package/doc/plugin-tls.optionspluginhost.md +0 -21
  206. package/doc/plugin-tls.pluginhost._constructor_.md +0 -13
  207. package/doc/plugin-tls.pluginhost.md +0 -25
  208. package/doc/plugin-tls.pluginmanager.instuse.md +0 -30
  209. package/doc/plugin-tls.pluginoptions.md +0 -11
  210. /package/doc/{index.md → api/index.md} +0 -0
@@ -0,0 +1,28 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManagerWithInit](./plugin-tls.pluginmanagerwithinit.md) &gt; [inited](./plugin-tls.pluginmanagerwithinit.inited.md)
4
+
5
+ ## PluginManagerWithInit.inited() method
6
+
7
+ 插件宿主创建实例时调用
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ inited(hostInst: HostInst<HostClassType>): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | hostInst | [HostInst](./plugin-tls.hostinst.md)<!-- -->&lt;HostClassType&gt; | 插件宿主的新实例 |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Remarks
26
+
27
+ 会调用每个插件的 [IPlugin.created()](./plugin-tls.iplugin.created.md) 方法
28
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginManagerWithInit](./plugin-tls.pluginmanagerwithinit.md)
4
+
5
+ ## PluginManagerWithInit class
6
+
7
+ 插件管理者
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class PluginManagerWithInit<HostClassType, Plugin extends IPluginWithInit<HostClassType, any> = IPluginWithInit<HostClassType, any>> extends PluginManager<HostClassType, Plugin>
13
+ ```
14
+ **Extends:** [PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;HostClassType, Plugin&gt;
15
+
16
+ ## Remarks
17
+
18
+ 负责管理插件的注册、应用 等
19
+
20
+ ## Methods
21
+
22
+ | Method | Modifiers | Description |
23
+ | --- | --- | --- |
24
+ | [inited(hostInst)](./plugin-tls.pluginmanagerwithinit.inited.md) | | 插件宿主创建实例时调用 |
25
+
@@ -6,10 +6,10 @@
6
6
 
7
7
  插件的 used 方法的返回值类型
8
8
 
9
- <b>Signature:</b>
9
+ **Signature:**
10
10
 
11
11
  ```typescript
12
- export declare type PluginUseReturnType<P extends IPlugin<any>> = ReturnType<P["used"]>;
12
+ export type PluginUseReturnType<P extends IPlugin<any, any>> = ReturnType<P["used"]>;
13
13
  ```
14
- <b>References:</b> [IPlugin](./plugin-tls.iplugin.md)
14
+ **References:** [IPlugin](./plugin-tls.iplugin.md)
15
15
 
@@ -0,0 +1,32 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md) &gt; [\_constructor](./plugin-tls.privatememberofextend._constructor.md)
4
+
5
+ ## PrivateMemberOfExtend.\_constructor() method
6
+
7
+ 扩展类中用于定义在创建实例时的初始化的方法
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ _constructor?(...args: (TargetType extends new (...args: infer A) => any ? A : never)): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | args | (TargetType extends new (...args: infer A) =&gt; any ? A : never) | |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Remarks
26
+
27
+ 该方法会在创建实例时自动执行,并将构建函数接收到的参数透传给方方法。
28
+
29
+ 注意: \_constructor 会被保存在 目标类中的 \_constructors 属性中,它是一个数组。
30
+
31
+ 目标类 需要在自己的构建函数中逐个调用 cla.\_constructors 中的函数
32
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md) &gt; [\_destroy](./plugin-tls.privatememberofextend._destroy.md)
4
+
5
+ ## PrivateMemberOfExtend.\_destroy() method
6
+
7
+ 扩展类中用于定义在实例销毁时触发的销毁方法
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ _destroy?(): void;
13
+ ```
14
+ **Returns:**
15
+
16
+ void
17
+
18
+ ## Remarks
19
+
20
+ 该方法会在实例销毁时自动调用
21
+
22
+ 注意: \_destroy 会被保存在 目标类中的 \_destroys 属性中,它是一个数组。
23
+
24
+ 如果目标类有销毁逻辑,则需要在自己的销毁函数中逐个调用 cla.\_destroys 中的函数
25
+
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)
4
+
5
+ ## PrivateMemberOfExtend interface
6
+
7
+ 用于定义扩展选项中的私有成员
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface PrivateMemberOfExtend<TargetType extends new (...args: any) => any>
13
+ ```
14
+
15
+ ## Methods
16
+
17
+ | Method | Description |
18
+ | --- | --- |
19
+ | [\_constructor(args)?](./plugin-tls.privatememberofextend._constructor.md) | _(Optional)_ 扩展类中用于定义在创建实例时的初始化的方法 |
20
+ | [\_destroy()?](./plugin-tls.privatememberofextend._destroy.md) | _(Optional)_ 扩展类中用于定义在实例销毁时触发的销毁方法 |
21
+
@@ -0,0 +1,28 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md) &gt; [\_init](./plugin-tls.privatememberofextendwithinit._init.md)
4
+
5
+ ## PrivateMemberOfExtendWithInit.\_init() method
6
+
7
+ 扩展类中用于定义实例初始化逻辑的方法
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ _init?(...args: InitParams): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | args | InitParams | |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Remarks
26
+
27
+ 该方法会在调用实例的 `init()` 方法时自动执行。
28
+
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md)
4
+
5
+ ## PrivateMemberOfExtendWithInit interface
6
+
7
+ 用于定义扩展选项中的私有成员
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface PrivateMemberOfExtendWithInit<TargetType extends new (...args: any) => any, InitParams extends any[] = any> extends PrivateMemberOfExtend<TargetType>
13
+ ```
14
+ **Extends:** [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)<!-- -->&lt;TargetType&gt;
15
+
16
+ ## Methods
17
+
18
+ | Method | Description |
19
+ | --- | --- |
20
+ | [\_init(args)?](./plugin-tls.privatememberofextendwithinit._init.md) | _(Optional)_ 扩展类中用于定义实例初始化逻辑的方法 |
21
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [ReplaceConstructorParameters](./plugin-tls.replaceconstructorparameters.md)
4
+
5
+ ## ReplaceConstructorParameters type
6
+
7
+ 替换构建函数的参数
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type ReplaceConstructorParameters<C extends new (...args: any) => any, NewParms extends any[]> = new (...args: NewParms) => InstanceType<C>;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [ReplaceConstructorReturn](./plugin-tls.replaceconstructorreturn.md)
4
+
5
+ ## ReplaceConstructorReturn type
6
+
7
+ 替换构造函数的返回类型
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type ReplaceConstructorReturn<C extends new (...args: any) => any, NewReturn> = new (...args: ConstructorParameters<C>) => NewReturn;
13
+ ```
@@ -0,0 +1,27 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [setPropertyValue](./plugin-tls.setpropertyvalue.md)
4
+
5
+ ## setPropertyValue() function
6
+
7
+ 通过属性路径列表设置对象中对应属性的值
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function setPropertyValue(obj: any, props: string[], value: any): any;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | obj | any | |
20
+ | props | string\[\] | |
21
+ | value | any | |
22
+
23
+ **Returns:**
24
+
25
+ any
26
+
27
+
@@ -0,0 +1,27 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [setPropertyValueByPath](./plugin-tls.setpropertyvaluebypath.md)
4
+
5
+ ## setPropertyValueByPath() function
6
+
7
+ 获取对象的属性路径对应的属性值
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function setPropertyValueByPath(obj: any, propPath: string, value: any): any;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | obj | any | |
20
+ | propPath | string | |
21
+ | value | any | |
22
+
23
+ **Returns:**
24
+
25
+ any
26
+
27
+
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [targetExtend](./plugin-tls.targetextend.md)
4
+
5
+ ## targetExtend() function
6
+
7
+ 扩展目标
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function targetExtend<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtend<C>): E & ThisType<InstanceType<C> & E>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | cla | C | 扩展的目标,也用作 this 的类型 |
20
+ | ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtend](./plugin-tls.privatememberofextend.md)<!-- -->&lt;C&gt; | 扩展描述对象,会自动更改其this的类型 |
21
+
22
+ **Returns:**
23
+
24
+ E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt;
25
+
26
+ 返回注入了 this 类型的 ext 对象本身
27
+
28
+ ## Remarks
29
+
30
+ 与 [defineExtend()](./plugin-tls.defineextend.md) 的区别是:`targetExtend` 会执行对 cla 的扩展操作,而 [defineExtend()](./plugin-tls.defineextend.md) 不会
31
+
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [targetExtendWithInit](./plugin-tls.targetextendwithinit.md)
4
+
5
+ ## targetExtendWithInit() function
6
+
7
+ 扩展目标
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function targetExtendWithInit<C extends ClassType, E>(cla: C, ext: E & ThisType<InstanceType<C> & E> & PrivateMemberOfExtendWithInit<C>): E & ThisType<InstanceType<C> & E>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | cla | C | 扩展的目标,也用作 this 的类型 |
20
+ | ext | E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt; &amp; [PrivateMemberOfExtendWithInit](./plugin-tls.privatememberofextendwithinit.md)<!-- -->&lt;C&gt; | 扩展描述对象,会自动更改其this的类型 |
21
+
22
+ **Returns:**
23
+
24
+ E &amp; ThisType&lt;InstanceType&lt;C&gt; &amp; E&gt;
25
+
26
+ 返回注入了 this 类型的 ext 对象本身
27
+
28
+ ## Remarks
29
+
30
+ 与 [defineExtendWithInit()](./plugin-tls.defineextendwithinit.md) 的区别是:`targetExtend` 会执行对 cla 的扩展操作,而 [defineExtendWithInit()](./plugin-tls.defineextendwithinit.md) 不会
31
+
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [targetMixin](./plugin-tls.targetmixin.md)
4
+
5
+ ## targetMixin() function
6
+
7
+ 混合目标
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function targetMixin<T, M>(target: T, m: M & ThisType<T & M>): M & ThisType<T & M>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | target | T | 混合的目标,用作 this 的类型 |
20
+ | m | M &amp; ThisType&lt;T &amp; M&gt; | 混合对象,会自动更改其this的类型 |
21
+
22
+ **Returns:**
23
+
24
+ M &amp; ThisType&lt;T &amp; M&gt;
25
+
26
+ 返回注入了 this 类型的 mixin 对象本身
27
+
28
+ ## Remarks
29
+
30
+ 与 [defineMixin()](./plugin-tls.definemixin.md) 的区别是:`targetMixin` 会执行对 target 的混合操作,而 [defineMixin()](./plugin-tls.definemixin.md) 不会
31
+
@@ -0,0 +1,20 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [(constructor)](./plugin-tls.tiermodeoptions._constructor_.md)
4
+
5
+ ## TierModeOptions.(constructor)
6
+
7
+ Constructs a new instance of the `TierModeOptions` class
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ constructor(mode: Mode);
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | mode | Mode | |
20
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [(constructor)](./plugin-tls.tiermodeoptions._constructor__1.md)
4
+
5
+ ## TierModeOptions.(constructor)
6
+
7
+ Constructs a new instance of the `TierModeOptions` class
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ constructor(mode: Mode, options?: Option, extend?: TierModeOptions<Mode, Option>);
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | mode | Mode | |
20
+ | options | Option | _(Optional)_ |
21
+ | extend | [TierModeOptions](./plugin-tls.tiermodeoptions.md)<!-- -->&lt;Mode, Option&gt; | _(Optional)_ |
22
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [\_extends](./plugin-tls.tiermodeoptions._extends.md)
4
+
5
+ ## TierModeOptions.\_extends property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected _extends: TierModeOptions<Mode, Option> | null;
11
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [extends](./plugin-tls.tiermodeoptions.extends.md)
4
+
5
+ ## TierModeOptions.extends property
6
+
7
+ 继承的选项
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get extends(): TierModeOptions<Mode, Option> | null;
13
+
14
+ set extends(value: TierModeOptions<Mode, Option> | null);
15
+ ```
@@ -0,0 +1,29 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [getFullModeOption](./plugin-tls.tiermodeoptions.getfullmodeoption.md)
4
+
5
+ ## TierModeOptions.getFullModeOption() method
6
+
7
+ 返回已合并继承选项的最终选项
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getFullModeOption(mode: Mode): Option | null;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | mode | Mode | |
20
+
21
+ **Returns:**
22
+
23
+ Option \| null
24
+
25
+
26
+ ## Remarks
27
+
28
+ 与继承选项只是浅合并
29
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [getMember](./plugin-tls.tiermodeoptions.getmember.md)
4
+
5
+ ## TierModeOptions.getMember() method
6
+
7
+ 获取选项成员
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getMember<Key extends keyof Option>(key: Key): Option[Key] | undefined | null;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | key | Key | |
20
+
21
+ **Returns:**
22
+
23
+ Option\[Key\] \| undefined \| null
24
+
25
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [getModeNames](./plugin-tls.tiermodeoptions.getmodenames.md)
4
+
5
+ ## TierModeOptions.getModeNames() method
6
+
7
+ 获取所有的模式名字
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getModeNames(): Mode[];
13
+ ```
14
+ **Returns:**
15
+
16
+ Mode\[\]
17
+
18
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [getModeOptionManager](./plugin-tls.tiermodeoptions.getmodeoptionmanager.md)
4
+
5
+ ## TierModeOptions.getModeOptionManager() method
6
+
7
+ 获取模式对应的选项管理器
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getModeOptionManager(mode: Mode): TierOptions<Option> | null;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | mode | Mode | |
20
+
21
+ **Returns:**
22
+
23
+ [TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Option&gt; \| null
24
+
25
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [getValue](./plugin-tls.tiermodeoptions.getvalue.md)
4
+
5
+ ## TierModeOptions.getValue() method
6
+
7
+ 获取属性路径对应的值
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getValue(propPath: string[]): any;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | propPath | string\[\] | |
20
+
21
+ **Returns:**
22
+
23
+ any
24
+
25
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [hasModeOnTier](./plugin-tls.tiermodeoptions.hasmodeontier.md)
4
+
5
+ ## TierModeOptions.hasModeOnTier() method
6
+
7
+ 在整个层级上判断是否有某个模式
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ hasModeOnTier(mode: string | number): boolean;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | mode | string \| number | |
20
+
21
+ **Returns:**
22
+
23
+ boolean
24
+
25
+
@@ -0,0 +1,45 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md)
4
+
5
+ ## TierModeOptions class
6
+
7
+ 层级模式选项
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class TierModeOptions<Mode extends string | number = string, Option extends {} = any> extends ModeOptions<Mode, Option>
13
+ ```
14
+ **Extends:** [ModeOptions](./plugin-tls.modeoptions.md)<!-- -->&lt;Mode, Option&gt;
15
+
16
+ ## Remarks
17
+
18
+ 即 ModeOptions 和 TierOptions 的结合
19
+
20
+ ## Constructors
21
+
22
+ | Constructor | Modifiers | Description |
23
+ | --- | --- | --- |
24
+ | [(constructor)(mode)](./plugin-tls.tiermodeoptions._constructor_.md) | | Constructs a new instance of the <code>TierModeOptions</code> class |
25
+ | [(constructor)(mode, options, extend)](./plugin-tls.tiermodeoptions._constructor__1.md) | | Constructs a new instance of the <code>TierModeOptions</code> class |
26
+
27
+ ## Properties
28
+
29
+ | Property | Modifiers | Type | Description |
30
+ | --- | --- | --- | --- |
31
+ | [\_extends](./plugin-tls.tiermodeoptions._extends.md) | <code>protected</code> | [TierModeOptions](./plugin-tls.tiermodeoptions.md)<!-- -->&lt;Mode, Option&gt; \| null | |
32
+ | [extends](./plugin-tls.tiermodeoptions.extends.md) | | [TierModeOptions](./plugin-tls.tiermodeoptions.md)<!-- -->&lt;Mode, Option&gt; \| null | 继承的选项 |
33
+ | [optionManager](./plugin-tls.tiermodeoptions.optionmanager.md) | <code>readonly</code> | [TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Option&gt; | 当前模式的选项 |
34
+
35
+ ## Methods
36
+
37
+ | Method | Modifiers | Description |
38
+ | --- | --- | --- |
39
+ | [getFullModeOption(mode)](./plugin-tls.tiermodeoptions.getfullmodeoption.md) | | 返回已合并继承选项的最终选项 |
40
+ | [getMember(key)](./plugin-tls.tiermodeoptions.getmember.md) | | 获取选项成员 |
41
+ | [getModeNames()](./plugin-tls.tiermodeoptions.getmodenames.md) | | 获取所有的模式名字 |
42
+ | [getModeOptionManager(mode)](./plugin-tls.tiermodeoptions.getmodeoptionmanager.md) | | 获取模式对应的选项管理器 |
43
+ | [getValue(propPath)](./plugin-tls.tiermodeoptions.getvalue.md) | | 获取属性路径对应的值 |
44
+ | [hasModeOnTier(mode)](./plugin-tls.tiermodeoptions.hasmodeontier.md) | | 在整个层级上判断是否有某个模式 |
45
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [TierModeOptions](./plugin-tls.tiermodeoptions.md) &gt; [optionManager](./plugin-tls.tiermodeoptions.optionmanager.md)
4
+
5
+ ## TierModeOptions.optionManager property
6
+
7
+ 当前模式的选项
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get optionManager(): TierOptions<Option>;
13
+ ```