主题
Module: config
Variables
defaultConfig
• Const defaultConfig: MermaidConfig
Defined in
packages/mermaid/src/config.ts:8
Functions
addDirective
▸ addDirective(directive): void
Pushes in a directive to the configuration
Parameters
| Name | Type | Description |
|---|---|---|
directive | MermaidConfig | 要推送的指令 |
Returns
void
Defined in
packages/mermaid/src/config.ts:182
getConfig
▸ getConfig(): MermaidConfig
getConfig
| 函数 | 描述 | 类型 | Return Values |
|---|---|---|---|
| getConfig | Obtains the currentConfig | Get Request | Any Values from current Config |
注意：避免重复调用此函数。相反，将结果存储在变量中并使用它，然后将其传递给函数调用。
Returns
当前配置
Defined in
packages/mermaid/src/config.ts:126
getSiteConfig
▸ getSiteConfig(): MermaidConfig
getSiteConfig
| 函数 | 描述 | 类型 | 值 |
|---|---|---|---|
| setSiteConfig | Returns the current siteConfig base configuration | Get Request | Returns Any Values in siteConfig |
注意：返回 siteConfig 中的 任何 值。
Returns
站点配置
Defined in
packages/mermaid/src/config.ts:93
reset
▸ reset(config?): void
reset
| 函数 | 描述 | 类型 | 必需 | 值 |
|---|---|---|---|---|
| reset | Resets currentConfig to conf | Put Request | 必需 | None |
conf
| Parameter | 描述 | 类型 | 必需 | 值 |
|---|---|---|---|---|
| conf | base set of values, which currentConfig could be reset to. | Dictionary | 必需 | Any Values, with respect to the secure Array |
注意：（默认：当前 siteConfig ）（可选，默认 getSiteConfig()）
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
config | MermaidConfig | siteConfig | currentConfig 可以重置为基本值集。默认为当前 siteConfig（例如由 getSiteConfig 返回）。 |
Returns
void
Defined in
packages/mermaid/src/config.ts:214
sanitize
▸ sanitize(options): void
sanitize
| 函数 | 描述 | 类型 | 值 |
|---|---|---|---|
| sanitize | Sets the siteConfig to desired values. | Put Request | None |
确保选项参数不会尝试覆盖 siteConfig 安全密钥 注意：就地修改选项
Parameters
| Name | Type | Description |
|---|---|---|
options | any | 潜在的 setConfig 参数 |
Returns
void
Defined in
packages/mermaid/src/config.ts:140
saveConfigFromInitialize
▸ saveConfigFromInitialize(conf): void
Parameters
| Name | Type |
|---|---|
conf | MermaidConfig |
Returns
void
Defined in
packages/mermaid/src/config.ts:72
setConfig
▸ setConfig(conf): MermaidConfig
setConfig
| 函数 | 描述 | 类型 | 值 |
|---|---|---|---|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
注意：设置当前配置。参数 conf 根据 siteConfig.secure 键进行清理。在 conf 中找到的任何值，如果在 siteConfig.secure 中找到键，则将替换为相应的 siteConfig 值。
Parameters
| Name | Type | Description |
|---|---|---|
conf | MermaidConfig | 潜在的 currentConfig |
Returns
当前配置与已清理的配置合并
Defined in
packages/mermaid/src/config.ts:108
setSiteConfig
▸ setSiteConfig(conf): MermaidConfig
setSiteConfig
| 函数 | 描述 | 类型 | 值 |
|---|---|---|---|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
**注意：**设置 siteConfig。siteConfig 是受保护的配置，可重复使用。调用 reset() 会将当前配置重置为 siteConfig。调用 reset(configApi.defaultConfig) 将重置 siteConfig 和 currentConfig 为 defaultConfig 注意：currentConfig 在此函数中设置 _ 默认值：默认情况下，将镜像全局配置 _
Parameters
| Name | Type | Description |
|---|---|---|
conf | MermaidConfig | 用作 siteConfig 的基本 currentConfig |
Returns
新的站点配置
Defined in
packages/mermaid/src/config.ts:58
updateCurrentConfig
▸ updateCurrentConfig(siteCfg, _directives): MermaidConfig
Parameters
| Name | Type |
|---|---|
siteCfg | MermaidConfig |
_directives | MermaidConfig[] |
Returns
Defined in
packages/mermaid/src/config.ts:15
updateSiteConfig
▸ updateSiteConfig(conf): MermaidConfig
Parameters
| Name | Type |
|---|---|
conf | MermaidConfig |