plugin-tls/doc/api/plugin-tls.modeoptions.md

plugin-tls 是插件系统相应的工具，可快速地让任何模块具备插件机制

<!-- 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>