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.modeoptions.md DELETED Viewed

@@ -1,381 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [ModeOptions](./plugin-tls.modeoptions.md)
-## ModeOptions class
-模式选项
-**Signature:**
-```typescript
-export declare class ModeOptions<Mode extends string | number = string, Option extends {} = any> extends OptionsManager<Option>
-```
-**Extends:** OptionsManager&lt;Option&gt;
-## Remarks
-针对选项提供了模式和继承的功能；
-适用以下场景： 你设计了一个支持许多选项的工具，不同场景下需要配置不同的选项值，比如有如下几个场景： - 性能模式：所有的配置项以性能为目标进行配置，关闭那些效果类的选项； - 特效模式：以高质量的渲染效果为目标进行配置，会开启所有的效果选项； - 平衡模式：兼顾性能和效果，取个折中；
-并且这些模式也会一些共同的选项；
-使用该类，你可以： - 设置一个基本模式：该模式提供的所有模式都会有的共用选项 - 设置 性能模式、特效模式、平衡模式 继承 基本模式；
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(mode)](./plugin-tls.modeoptions._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `ModeOptions` class
-</td></tr>
-<tr><td>
-[(constructor)(mode, options)](./plugin-tls.modeoptions._constructor__1.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `ModeOptions` 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>
-[\_mode?](./plugin-tls.modeoptions._mode.md)
-</td><td>
-`protected`
-</td><td>
-Mode
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[\_modeNames](./plugin-tls.modeoptions._modenames.md)
-</td><td>
-`protected`
-</td><td>
-Mode\[\] \| null
-</td><td>
-</td></tr>
-<tr><td>
-[\_plainFullOption](./plugin-tls.modeoptions._plainfulloption.md)
-</td><td>
-`protected`
-</td><td>
-Option \| null
-</td><td>
-</td></tr>
-<tr><td>
-[mode](./plugin-tls.modeoptions.mode.md)
-</td><td>
-</td><td>
-Mode
-</td><td>
-当前模式
-</td></tr>
-<tr><td>
-[modeNames](./plugin-tls.modeoptions.modenames.md)
-</td><td>
-`readonly`
-</td><td>
-Mode\[\]
-</td><td>
-所有的模式名字
-</td></tr>
-<tr><td>
-[modes](./plugin-tls.modeoptions.modes.md)
-</td><td>
-</td><td>
-Record&lt;Mode, [TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Option&gt;&gt;
-</td><td>
-模式的配置
-</td></tr>
-<tr><td>
-[option](./plugin-tls.modeoptions.option.md)
-</td><td>
-`readonly`
-</td><td>
-Option
-</td><td>
-当前模式对应的选项
-</td></tr>
-<tr><td>
-[optionManager](./plugin-tls.modeoptions.optionmanager.md)
-</td><td>
-`readonly`
-</td><td>
-[TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Option&gt;
-</td><td>
-当前模式的选项
-</td></tr>
-<tr><td>
-[plainFullOption](./plugin-tls.modeoptions.plainfulloption.md)
-</td><td>
-`readonly`
-</td><td>
-Option
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[getFullModeOption(mode)](./plugin-tls.modeoptions.getfullmodeoption.md)
-</td><td>
-</td><td>
-返回已合并继承选项的完整选项
-</td></tr>
-<tr><td>
-[getModeNames()](./plugin-tls.modeoptions.getmodenames.md)
-</td><td>
-</td><td>
-获取所有的模式名字
-</td></tr>
-<tr><td>
-[getModeOption(mode)](./plugin-tls.modeoptions.getmodeoption.md)
-</td><td>
-</td><td>
-返回已合并继承选项的选项
-</td></tr>
-<tr><td>
-[hasMode(mode)](./plugin-tls.modeoptions.hasmode.md)
-</td><td>
-</td><td>
-判断是否有某个模式
-</td></tr>
-<tr><td>
-[setModeOption(mode, option, deep, extend)](./plugin-tls.modeoptions.setmodeoption.md)
-</td><td>
-</td><td>
-给模式设置选项
-</td></tr>
-<tr><td>
-[updateFullOption()](./plugin-tls.modeoptions.updatefulloption.md)
-</td><td>
-</td><td>
-更新
-</td></tr>
-</tbody></table>

package/doc/api/plugin-tls.modeoptions.mode.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; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [mode](./plugin-tls.modeoptions.mode.md)
-## ModeOptions.mode property
-当前模式
-**Signature:**
-```typescript
-get mode(): Mode;
-set mode(value: Mode);
-```

package/doc/api/plugin-tls.modeoptions.modenames.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; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [modeNames](./plugin-tls.modeoptions.modenames.md)
-## ModeOptions.modeNames property
-所有的模式名字
-**Signature:**
-```typescript
-get modeNames(): Mode[];
-```

package/doc/api/plugin-tls.modeoptions.modes.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; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [modes](./plugin-tls.modeoptions.modes.md)
-## ModeOptions.modes property
-模式的配置
-**Signature:**
-```typescript
-modes: Record<Mode, TierOptions<Option>>;
-```

package/doc/api/plugin-tls.modeoptions.option.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; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [option](./plugin-tls.modeoptions.option.md)
-## ModeOptions.option property
-当前模式对应的选项
-**Signature:**
-```typescript
-get option(): Option;
-```

package/doc/api/plugin-tls.modeoptions.optionmanager.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; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [optionManager](./plugin-tls.modeoptions.optionmanager.md)
-## ModeOptions.optionManager property
-当前模式的选项
-**Signature:**
-```typescript
-get optionManager(): TierOptions<Option>;
-```

package/doc/api/plugin-tls.modeoptions.plainfulloption.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [plainFullOption](./plugin-tls.modeoptions.plainfulloption.md)
-## ModeOptions.plainFullOption property
-**Signature:**
-```typescript
-get plainFullOption(): Option;
-```

package/doc/api/plugin-tls.modeoptions.setmodeoption.md DELETED Viewed

@@ -1,98 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [setModeOption](./plugin-tls.modeoptions.setmodeoption.md)
-## ModeOptions.setModeOption() method
-给模式设置选项
-**Signature:**
-```typescript
-setModeOption(mode: Mode, option: Option, deep?: boolean, extend?: Mode): Record<Mode, TierOptions<Option>>[Mode];
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-mode
-</td><td>
-Mode
-</td><td>
-</td></tr>
-<tr><td>
-option
-</td><td>
-Option
-</td><td>
-</td></tr>
-<tr><td>
-deep
-</td><td>
-boolean
-</td><td>
-_(Optional)_ 是否要进行深度合并
-</td></tr>
-<tr><td>
-extend
-</td><td>
-Mode
-</td><td>
-_(Optional)_ 继承哪个模式
-</td></tr>
-</tbody></table>
-**Returns:**
-Record&lt;Mode, [TierOptions](./plugin-tls.tieroptions.md)<!-- -->&lt;Option&gt;&gt;\[Mode\]

package/doc/api/plugin-tls.modeoptions.updatefulloption.md DELETED Viewed

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [ModeOptions](./plugin-tls.modeoptions.md) &gt; [updateFullOption](./plugin-tls.modeoptions.updatefulloption.md)
-## ModeOptions.updateFullOption() method
-更新
-**Signature:**
-```typescript
-updateFullOption(): void;
-```
-**Returns:**
-void

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

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [NormalizePluginOptions](./plugin-tls.normalizepluginoptions.md)
-## NormalizePluginOptions type
-将选项格式成方法的参数类型
-**Signature:**
-```typescript
-export type NormalizePluginOptions<Options> = Options extends never | void | undefined ? void : Options;
-```
-## Remarks
-如果是 never\|void\|undefined 类型，则会被转为 void

package/doc/api/plugin-tls.parsepropertypath.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; [parsePropertyPath](./plugin-tls.parsepropertypath.md)
-## parsePropertyPath() function
-解析属性路径为属性列表
-**Signature:**
-```typescript
-export declare function parsePropertyPath(propPath: string): string[];
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-propPath
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-string\[\]

package/doc/api/plugin-tls.plugincreatedreturntype.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; [PluginCreatedReturnType](./plugin-tls.plugincreatedreturntype.md)
-## PluginCreatedReturnType type
-插件的 created 方法的返回值类型
-**Signature:**
-```typescript
-export type PluginCreatedReturnType<P extends IPlugin<any, any>> = P["created"] extends AnyFunction ? ReturnType<P["created"]> : void;
-```
-**References:** [IPlugin](./plugin-tls.iplugin.md)

package/doc/api/plugin-tls.pluginhost._pluginmanager.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginHost](./plugin-tls.pluginhost.md) &gt; [\_pluginManager](./plugin-tls.pluginhost._pluginmanager.md)
-## PluginHost.\_pluginManager property
-**Signature:**
-```typescript
-protected static _pluginManager: PluginManager<any>;
-```

package/doc/api/plugin-tls.pluginhost.destroythis.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [plugin-tls](./plugin-tls.md) &gt; [PluginHost](./plugin-tls.pluginhost.md) &gt; [destroyThis](./plugin-tls.pluginhost.destroythis.md)
-## PluginHost.destroyThis() method
-销毁实例
-**Signature:**
-```typescript
-destroyThis(): void;
-```
-**Returns:**
-void