plugin-tls 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 郭斌勇
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+[教程]: ./docs/教程.md
+[API接口文档]: ./doc/index.md
+
+[GitHub仓库]: https://github.com/GuoBinyong/library-vite-template
+[发行地址]: https://github.com/GuoBinyong/library-vite-template/releases
+[issues]: https://github.com/GuoBinyong/library-vite-template/issues
+
+[码云仓库]: https://gitee.com/guobinyong/library-vite-template
+
+
+
+> 目录
+
+- [1. 背景](#1-背景)
+- [2. 简介](#2-简介)
+- [3. 安装方式](#3-安装方式)
+  - [3.1. 方式1：通过 npm 安装](#31-方式1通过-npm-安装)
+  - [3.2. 方式3：通过`<script>`标签引入](#32-方式3通过script标签引入)
+- [4. 教程](#4-教程)
+- [5. API接口文档](#5-api接口文档)
+
+
+
+# 1. 背景
+
+# 2. 简介
+库的简单介绍
+
+**具有以下特性：**  
+- 特性1
+- 特性2
+- 特性3
+
+**详情请看：**  
+- 主页：<https://github.com/GuoBinyong/library-vite-template>
+- [GitHub仓库][]
+- [码云仓库][]
+- [教程][]
+- [API接口文档][]
+
+
+**如果您在使用的过程中遇到了问题，或者有好的建议和想法，您都可以通过以下方式联系我，期待与您的交流：**
+- 给该仓库提交 [issues][]
+- 给我 Pull requests
+- 邮箱：<guobinyong@qq.com>
+- QQ：guobinyong@qq.com
+- 微信：keyanzhe
+
+
+
+
+
+# 3. 安装方式
+目前，安装方式有以下几种：
+
+
+## 3.1. 方式1：通过 npm 安装
+```
+npm install library-vite-template
+```
+
+
+
+
+## 3.2. 方式3：通过`<script>`标签引入
+您可直接从项目的 [发行地址][] 中下载以 `.iife.js` 作为缀的文件，然后使用如下代码引用 和 使用 library-vite-template：
+
+
+1. 引用 library-vite-template
+   ```
+   <script src="path/to/package/library-vite-template.iife.js"></script>
+   ```
+   
+2. 使用全局的 `library-vite-template`
+   ```
+   <script>
+   // 使用全局的 library-vite-template
+   </script>
+   ```
+
+# 4. 教程
+详情跳转至[教程][]
+
+# 5. API接口文档
+详情跳转至[API接口文档][]
+
+
+
+--------------------
+
+> 有您的支持，我会在开源的道路上，越走越远
+
+![赞赏码](https://i.loli.net/2020/04/08/PGsAEqdJCin1oQL.jpg)

package/dist/OptionsPluginHost.d.ts

@@ -0,0 +1,49 @@
+import { PluginHost, IPluginHost, IPluginHostConstructor } from "./PluginHost";
+/**
+ * 选项插件宿主接口
+ */
+export interface IOptionsPluginHost<Options, HOST> extends IPluginHost<HOST> {
+    readonly defaultOptions: Options;
+}
+/**
+ * 选项插件宿主的构建函数接口
+ */
+export interface IOptionsPluginHostConstructor<Options, HOST> extends IPluginHostConstructor<HOST> {
+    get defaultOptions(): Options;
+}
+export declare class OptionsPluginHost<Options = any> extends PluginHost {
+    /**
+     * 全局级别的默认选项
+     */
+    static readonly defaultOptions: any;
+    /**
+     * 实例级的默认选项
+     */
+    get defaultOptions(): Options;
+    protected _defaultOptions: Options;
+}
+/**
+ * 创建带有选项机制的插件宿主类
+ * @remakers
+ * 比 直接使用 OptionsPluginHost 提供了完善的类型推导
+ *
+ * @returns
+ */
+export declare function createOptionsPluginHost<HOST, Options>(): {
+    new (): {
+        /**
+         * 实例级的默认选项
+         */
+        readonly defaultOptions: Options;
+        _defaultOptions: Options;
+        readonly pluginManager: import("./PluginManager").PluginManager<HOST>;
+        use<Options_1 extends unknown, Plugin_1 extends import("./PluginManager").IPlugin<HOST, Options_1>>(plugin: Plugin_1, options?: Options_1 | undefined): import("./PluginManager").PluginCreatedReturnType<Plugin_1> | undefined;
+    };
+    /**
+     * 全局级别的默认选项
+     */
+    readonly defaultOptions: Options;
+    readonly pluginManager: import("./PluginManager").PluginManager<HOST>;
+    _pluginManager: import("./PluginManager").PluginManager<HOST>;
+    use<Options_2>(plugin: import("./PluginManager").IPlugin<HOST, Options_2>, options: Options_2): any;
+};

package/dist/PluginHost.d.ts

@@ -0,0 +1,96 @@
+import { PluginManager, IPlugin, PluginOptions, PluginCreatedReturnType, PluginUseReturnType } from "./PluginManager";
+/**
+ * 插件宿主的接口
+ */
+export interface IPluginHost<HOST> {
+    /**
+  * PluginHost 的插件管理器
+  */
+    get pluginManager(): PluginManager<HOST>;
+    /**
+  * 实例的注册插件的方法
+  * @param plugin
+  * @param options
+  * @returns
+  */
+    use<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+/**
+ * 插件宿主构造函数的接口
+ */
+export interface IPluginHostConstructor<HOST> {
+    /**
+   * PluginHost 的插件管理器
+   */
+    get pluginManager(): PluginManager<HOST>;
+    /**
+     * {@inheritDoc PluginManager.use}
+     */
+    use<Plugin extends IPlugin<HOST, Options>, Options>(plugin: Plugin, options: Options): PluginUseReturnType<Plugin> | undefined;
+}
+/**
+ * 插件的宿主
+ *
+ * @remarks
+ * 插件宿主 就是 拥有插件机制的宿主
+ */
+export declare class PluginHost {
+    /**
+     * 插件管理器
+     */
+    static get pluginManager(): PluginManager<any>;
+    static _pluginManager: PluginManager<any>;
+    /**
+     * 插件管理器 {@link PluginHost.pluginManager}
+     */
+    get pluginManager(): PluginManager<any>;
+    /**
+     * {@inheritDoc PluginManager.use}
+     */
+    static use<Plugin extends IPlugin<HOST, Options>, Options extends PluginOptions, HOST = typeof PluginHost>(plugin: Plugin, options: Options): ReturnType<Plugin["used"]> | undefined;
+    constructor();
+    /**
+     * 实例的注册插件的方法
+     * @param plugin
+     * @param options
+     * @returns
+     */
+    use<Options extends PluginOptions, Plugin extends IPlugin<typeof PluginHost, Options>>(plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+/**
+ * 创建插件的缩主类
+ *
+ * @remarks
+ * 比 直接使用 PluginHost 提供了完善的类型推导
+ * @returns
+ */
+export declare function createPluginHost<HOST>(): {
+    new (): {
+        /**
+     *  插件管理器 {@link CEarth.pluginManager}
+     */
+        readonly pluginManager: PluginManager<HOST>;
+        /**
+     * 实例的注册插件的方法
+     * @param plugin
+     * @param options
+     * @returns
+     */
+        use<Options extends unknown, Plugin_1 extends IPlugin<HOST, Options>>(plugin: Plugin_1, options?: Options | undefined): PluginCreatedReturnType<Plugin_1> | undefined;
+    };
+    /**
+     * PluginHost 的插件管理器
+     */
+    readonly pluginManager: PluginManager<HOST>;
+    _pluginManager: PluginManager<HOST>;
+    /**
+     * {@inheritDoc PluginManager.use}
+     */
+    use<Options_1>(plugin: IPlugin<HOST, Options_1>, options: Options_1): any;
+};
+/**
+ * 插件缩主类的装饰器
+ * @param target
+ * @returns
+ */
+export declare function pluginHost<HOST extends new (...args: any) => any>(target: HOST): HOST;

package/dist/PluginManager.d.ts

@@ -0,0 +1,76 @@
+import { AnyFunction } from "type-tls";
+/**
+ * 插件宿主的实例类型
+ */
+export declare type HostInst<H> = H extends new (...args: any) => any ? InstanceType<H> : H;
+/**
+ * 插件的接口
+ *
+ * @typeParam HOST - 插件宿主的类类型
+ * @typeParam Options - 插件的选项类型
+ */
+export interface IPlugin<HOST, Options = any> {
+    /**
+     * 当插件被注册时调用
+     * @param Host - 宿主的类型
+     * @param options - 注册插件时的选项
+     */
+    used(Host: HOST, options?: Options): any;
+    /**
+     * 当宿主实例被创建时调用
+     * @param host - 新建的宿主实例
+     * @param options - 注册插件时的选项
+     */
+    created?(host: HostInst<HOST>, options?: Options): any;
+}
+export declare type PluginOptions = any;
+/**
+ * 插件的 used 方法的返回值类型
+ */
+export declare type PluginUseReturnType<P extends IPlugin<any>> = ReturnType<P["used"]>;
+/**
+ * 插件的 created 方法的返回值类型
+ */
+export declare type PluginCreatedReturnType<P extends IPlugin<any>> = P["created"] extends AnyFunction ? ReturnType<P["created"]> : void;
+/**
+ * 插件管理者
+ *
+ * @remarks
+ * 负责管理插件的注册、应用 等
+ */
+export declare class PluginManager<HOST> {
+    /**
+     * 插件的宿主
+     */
+    host: HOST;
+    /**
+     * 插件与插件选项的映射
+     */
+    pluginOptsMap: Map<IPlugin<HOST, any>, any>;
+    /**
+     * 注册的插件
+     */
+    plugins: IPlugin<HOST>[];
+    /**
+     * 使用插件、注册插件
+     * @param plugin - 插件
+     * @param options - 传递给插件的选项
+     */
+    use<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(plugin: Plugin, options?: Options): PluginUseReturnType<Plugin> | undefined;
+    /**
+     * 插件宿主创建实例时调用
+     *
+     * @remarks
+     * 会调用每个插件的 {@link IPlugin.created | IPlugin.created()} 方法
+     * @param hostInst - 插件宿主的新实例
+     */
+    created(hostInst: HostInst<HOST>): void;
+    /**
+     * 插件宿主实例的注册插件的方法
+     *
+     * @remarks
+     * 会调用每个插件的 {@link IPlugin.created | IPlugin.created()} 方法
+     * @param hostInst - 插件宿主的新实例
+     */
+    instUse<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(hostInst: HostInst<HOST>, plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}

package/dist/defaultOptions.d.ts

@@ -0,0 +1,33 @@
+import { Optional } from "type-tls";
+/**
+ * 默认选项宿主接口
+ */
+export interface IDefaultOptionsHost<Options> {
+    readonly defaultOptions: Options;
+}
+/**
+ * 默认选项宿主的构建函数接口
+ */
+export interface IIDefaultOptionsHostConstructor<Options> {
+    get defaultOptions(): Options;
+}
+/**
+ * 创建增加带有选项机制的装饰器
+ *
+ * @remarks
+ * 类装饰器的工厂函数
+ *
+ * @param options - 选项内容
+ * @returns
+ */
+export declare function addDefaultOptions<Options>(options: Options, name?: Optional<string>): <Clas extends new (...args: any) => any>(target: Clas) => void;
+/**
+ * 创建增加带有选项机制的装饰器
+ *
+ * @remarks
+ * 静态属性装饰器
+ *
+ * @param options - 选项内容
+ * @returns
+ */
+export declare function addInstOptions<Clas extends new (...args: any) => any>(target: Clas, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 插件系统
+ *
+ * @remarks
+ * 主要负责 SDK 的插件机制的实现
+ * 插件系统应该具备以下功能：
+ * - 注册插件
+ * - 可扩展类的静态级功能
+ * - 可扩展类的实例级功能
+ * - 可自定义暴露的功能
+ * - 可拥有私有自身的API
+ *
+ * 额外的也提供了其它的功能
+ * - 全局选项
+ * - 实例选项
+ *
+ * @packageDocumentation
+ */
+export * from "./PluginManager";
+export * from "./PluginHost";
+export * from "./OptionsPluginHost";
+export * from "./defaultOptions";

package/dist/plugin-tls.es.js

@@ -0,0 +1,170 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+import { mixinTarget, extendTarget } from "type-tls";
+import { deepCopy } from "@gby/deep-copy";
+class PluginManager {
+  constructor() {
+    __publicField(this, "host");
+    __publicField(this, "pluginOptsMap", /* @__PURE__ */ new Map());
+    __publicField(this, "plugins", []);
+  }
+  use(plugin, options) {
+    const pluginOptsMap = this.pluginOptsMap;
+    if (pluginOptsMap.has(plugin)) {
+      return;
+    }
+    this.plugins.push(plugin);
+    pluginOptsMap.set(plugin, options);
+    return plugin.used(this.host, options);
+  }
+  created(hostInst) {
+    var _a;
+    for (const plugin of this.plugins) {
+      const options = this.pluginOptsMap.get(plugin);
+      (_a = plugin.created) == null ? void 0 : _a.call(plugin, hostInst, options);
+    }
+  }
+  instUse(hostInst, plugin, options) {
+    var _a;
+    const pluginOptsMap = this.pluginOptsMap;
+    if (pluginOptsMap.has(plugin)) {
+      return;
+    }
+    this.use(plugin, options);
+    return (_a = plugin.created) == null ? void 0 : _a.call(plugin, hostInst, options);
+  }
+}
+class PluginHost {
+  static get pluginManager() {
+    let pluginManager = this._pluginManager;
+    if (!pluginManager) {
+      pluginManager = new PluginManager();
+      pluginManager.host = this;
+      this._pluginManager = pluginManager;
+    }
+    return pluginManager;
+  }
+  get pluginManager() {
+    return this.constructor.pluginManager;
+  }
+  static use(plugin, options) {
+    return this.pluginManager.use(plugin, options);
+  }
+  constructor() {
+    this.pluginManager.created(this);
+  }
+  use(plugin, options) {
+    return this.constructor.pluginManager.instUse(this, plugin, options);
+  }
+}
+__publicField(PluginHost, "_pluginManager");
+function createPluginHost() {
+  var _a;
+  return _a = class {
+    static get pluginManager() {
+      let pluginManager = this._pluginManager;
+      if (!pluginManager) {
+        pluginManager = new PluginManager();
+        pluginManager.host = this;
+        this._pluginManager = pluginManager;
+      }
+      return pluginManager;
+    }
+    get pluginManager() {
+      return this.constructor.pluginManager;
+    }
+    static use(plugin, options) {
+      return this.pluginManager.use(plugin, options);
+    }
+    constructor() {
+      this.pluginManager.created(this);
+    }
+    use(plugin, options) {
+      return this.pluginManager.instUse(this, plugin, options);
+    }
+  }, __publicField(_a, "_pluginManager"), _a;
+}
+function pluginHost(target) {
+  const newTarget = mixinTarget(target, {
+    get pluginManager() {
+      let pluginManager = this._pluginManager;
+      if (!pluginManager) {
+        pluginManager = new PluginManager();
+        pluginManager.host = this;
+        this._pluginManager = pluginManager;
+      }
+      return pluginManager;
+    },
+    use(plugin, options) {
+      return this.pluginManager.use(plugin, options);
+    }
+  });
+  mixinTarget(newTarget.prototype, {
+    get pluginManager() {
+      return this.constructor.pluginManager;
+    },
+    use(plugin, options) {
+      return this.pluginManager.instUse(this, plugin, options);
+    }
+  });
+  return new Proxy(target, {
+    construct: function(target2, argumentsList, receiver) {
+      const obj = new target2(...argumentsList);
+      newTarget.pluginManager.created(this);
+      return obj;
+    }
+  });
+}
+class OptionsPluginHost extends PluginHost {
+  constructor() {
+    super(...arguments);
+    __publicField(this, "_defaultOptions");
+  }
+  get defaultOptions() {
+    return this._defaultOptions || (this._defaultOptions = deepCopy(this.constructor.defaultOptions));
+  }
+}
+__publicField(OptionsPluginHost, "defaultOptions", {});
+function createOptionsPluginHost() {
+  var _a;
+  const PluginHost2 = createPluginHost();
+  return _a = class extends PluginHost2 {
+    constructor() {
+      super(...arguments);
+      __publicField(this, "_defaultOptions");
+    }
+    get defaultOptions() {
+      return this._defaultOptions || (this._defaultOptions = deepCopy(this.constructor.defaultOptions));
+    }
+  }, __publicField(_a, "defaultOptions", {}), _a;
+}
+function addDefaultOptions(options, name) {
+  const propName = name != null ? name : "defaultOptions";
+  const priName = `_${propName}`;
+  return function defaultOptions(target) {
+    const newTarget = mixinTarget(target, {
+      get [propName]() {
+        return options;
+      }
+    });
+    extendTarget(newTarget, {
+      get [propName]() {
+        return this[priName] || (this[priName] = structuredClone(newTarget.defaultOptions));
+      }
+    });
+  };
+}
+function addInstOptions(target, propertyKey, descriptor) {
+  const priName = `_${propertyKey}`;
+  extendTarget(target, {
+    get [propertyKey]() {
+      return this[priName] || (this[priName] = structuredClone(target[propertyKey]));
+    }
+  });
+  return descriptor;
+}
+export { OptionsPluginHost, PluginHost, PluginManager, addDefaultOptions, addInstOptions, createOptionsPluginHost, createPluginHost, pluginHost };

package/dist/plugin-tls.umd.js

@@ -0,0 +1 @@
+(function(s,i){typeof exports=="object"&&typeof module!="undefined"?i(exports,require("type-tls"),require("@gby/deep-copy")):typeof define=="function"&&define.amd?define(["exports","type-tls","@gby/deep-copy"],i):(s=typeof globalThis!="undefined"?globalThis:s||self,i(s.pluginTls={},s.typeTls,s.deepCopy))})(this,function(s,i,a){"use strict";var P=Object.defineProperty;var H=(s,i,a)=>i in s?P(s,i,{enumerable:!0,configurable:!0,writable:!0,value:a}):s[i]=a;var r=(s,i,a)=>(H(s,typeof i!="symbol"?i+"":i,a),a);class o{constructor(){r(this,"host");r(this,"pluginOptsMap",new Map);r(this,"plugins",[])}use(n,t){const e=this.pluginOptsMap;if(!e.has(n))return this.plugins.push(n),e.set(n,t),n.used(this.host,t)}created(n){var t;for(const e of this.plugins){const p=this.pluginOptsMap.get(e);(t=e.created)==null||t.call(e,n,p)}}instUse(n,t,e){var g;if(!this.pluginOptsMap.has(t))return this.use(t,e),(g=t.created)==null?void 0:g.call(t,n,e)}}class l{static get pluginManager(){let n=this._pluginManager;return n||(n=new o,n.host=this,this._pluginManager=n),n}get pluginManager(){return this.constructor.pluginManager}static use(n,t){return this.pluginManager.use(n,t)}constructor(){this.pluginManager.created(this)}use(n,t){return this.constructor.pluginManager.instUse(this,n,t)}}r(l,"_pluginManager");function c(){var u;return u=class{static get pluginManager(){let t=this._pluginManager;return t||(t=new o,t.host=this,this._pluginManager=t),t}get pluginManager(){return this.constructor.pluginManager}static use(t,e){return this.pluginManager.use(t,e)}constructor(){this.pluginManager.created(this)}use(t,e){return this.pluginManager.instUse(this,t,e)}},r(u,"_pluginManager"),u}function f(u){const n=i.mixinTarget(u,{get pluginManager(){let t=this._pluginManager;return t||(t=new o,t.host=this,this._pluginManager=t),t},use(t,e){return this.pluginManager.use(t,e)}});return i.mixinTarget(n.prototype,{get pluginManager(){return this.constructor.pluginManager},use(t,e){return this.pluginManager.instUse(this,t,e)}}),new Proxy(u,{construct:function(t,e,p){const g=new t(...e);return n.pluginManager.created(this),g}})}class h extends l{constructor(){super(...arguments);r(this,"_defaultOptions")}get defaultOptions(){return this._defaultOptions||(this._defaultOptions=a.deepCopy(this.constructor.defaultOptions))}}r(h,"defaultOptions",{});function M(){var n;const u=c();return n=class extends u{constructor(){super(...arguments);r(this,"_defaultOptions")}get defaultOptions(){return this._defaultOptions||(this._defaultOptions=a.deepCopy(this.constructor.defaultOptions))}},r(n,"defaultOptions",{}),n}function O(u,n){const t=n!=null?n:"defaultOptions",e=`_${t}`;return function(g){const d=i.mixinTarget(g,{get[t](){return u}});i.extendTarget(d,{get[t](){return this[e]||(this[e]=structuredClone(d.defaultOptions))}})}}function _(u,n,t){const e=`_${n}`;return i.extendTarget(u,{get[n](){return this[e]||(this[e]=structuredClone(u[n]))}}),t}s.OptionsPluginHost=h,s.PluginHost=l,s.PluginManager=o,s.addDefaultOptions=O,s.addInstOptions=_,s.createOptionsPluginHost=M,s.createPluginHost=c,s.pluginHost=f,Object.defineProperties(s,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/doc/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [plugin-tls](./plugin-tls.md) | 插件系统 |
+

package/doc/plugin-tls.adddefaultoptions.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; [addDefaultOptions](./plugin-tls.adddefaultoptions.md)
+
+## addDefaultOptions() function
+
+创建增加带有选项机制的装饰器
+
+<b>Signature:</b>
+
+```typescript
+export declare function addDefaultOptions<Options>(options: Options, name?: Optional<string>): <Clas extends new (...args: any) => any>(target: Clas) => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | 选项内容 |
+|  name | Optional&lt;string&gt; | <i>(Optional)</i> |
+
+<b>Returns:</b>
+
+&lt;Clas extends new (...args: any) =&gt; any&gt;(target: Clas) =&gt; void
+
+
+## Remarks
+
+类装饰器的工厂函数
+

package/doc/plugin-tls.addinstoptions.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; [addInstOptions](./plugin-tls.addinstoptions.md)
+
+## addInstOptions() function
+
+创建增加带有选项机制的装饰器
+
+<b>Signature:</b>
+
+```typescript
+export declare function addInstOptions<Clas extends new (...args: any) => any>(target: Clas, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | Clas |  |
+|  propertyKey | string |  |
+|  descriptor | PropertyDescriptor |  |
+
+<b>Returns:</b>
+
+PropertyDescriptor
+
+
+## Remarks
+
+静态属性装饰器
+

package/doc/plugin-tls.createoptionspluginhost.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [createOptionsPluginHost](./plugin-tls.createoptionspluginhost.md)
+
+## createOptionsPluginHost() function
+
+创建带有选项机制的插件宿主类  比 直接使用 OptionsPluginHost 提供了完善的类型推导
+
+<b>Signature:</b>
+
+```typescript
+export declare function createOptionsPluginHost<HOST, Options>(): {
+    new (): {
+        readonly defaultOptions: Options;
+        _defaultOptions: Options;
+        readonly pluginManager: import("./PluginManager").PluginManager<HOST>;
+        use<Options_1 extends unknown, Plugin_1 extends import("./PluginManager").IPlugin<HOST, Options_1>>(plugin: Plugin_1, options?: Options_1 | undefined): import("./PluginManager").PluginCreatedReturnType<Plugin_1> | undefined;
+    };
+    readonly defaultOptions: Options;
+    readonly pluginManager: import("./PluginManager").PluginManager<HOST>;
+    _pluginManager: import("./PluginManager").PluginManager<HOST>;
+    use<Options_2>(plugin: import("./PluginManager").IPlugin<HOST, Options_2>, options: Options_2): any;
+};
+```
+<b>Returns:</b>
+
+{ new (): { readonly defaultOptions: Options; \_defaultOptions: Options; readonly pluginManager: import("./PluginManager").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;HOST&gt;; use&lt;Options\_1 extends unknown, Plugin\_1 extends import("./PluginManager").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, Options\_1&gt;&gt;(plugin: Plugin\_1, options?: Options\_1 \| undefined): import("./PluginManager").[PluginCreatedReturnType](./plugin-tls.plugincreatedreturntype.md)<!-- -->&lt;Plugin\_1&gt; \| undefined; }; readonly defaultOptions: Options; readonly pluginManager: import("./PluginManager").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;HOST&gt;; \_pluginManager: import("./PluginManager").[PluginManager](./plugin-tls.pluginmanager.md)<!-- -->&lt;HOST&gt;; use&lt;Options\_2&gt;(plugin: import("./PluginManager").[IPlugin](./plugin-tls.iplugin.md)<!-- -->&lt;HOST, Options\_2&gt;, options: Options\_2): any; }
+
+