模組：config
變數
defaultConfig
• Const defaultConfig: MermaidConfig
定義於
packages/mermaid/src/config.ts:8
函式
addDirective
▸ addDirective(directive): void
將指令推入設定中
參數
| 名稱 | 類型 | 描述 |
|---|---|---|
directive | MermaidConfig | 要推入的指令 |
回傳
void
定義於
packages/mermaid/src/config.ts:188
getConfig
▸ getConfig(): MermaidConfig
getConfig
| 函式 | 描述 | 類型 | 回傳值 |
|---|---|---|---|
| getConfig | 取得 currentConfig | Get 請求 | currentConfig 中的任何值 |
注意：避免重複呼叫此函式。請改為將結果儲存在變數中並使用它，並將其傳遞給函式呼叫。
回傳
currentConfig
定義於
packages/mermaid/src/config.ts:131
getSiteConfig
▸ getSiteConfig(): MermaidConfig
getSiteConfig
| 函式 | 描述 | 類型 | 值 |
|---|---|---|---|
| setSiteConfig | 回傳目前的 siteConfig 基本設定 | Get 請求 | 回傳 siteConfig 中的任何值 |
注意：回傳 siteConfig 中的任何值。
回傳
siteConfig
定義於
packages/mermaid/src/config.ts:96
reset
▸ reset(config?): void
reset
| 函式 | 描述 | 類型 | 必要 | 值 |
|---|---|---|---|---|
| reset | 將 currentConfig 重設為 conf | Put 請求 | 必要 | 無 |
conf
| 參數 | 描述 | 類型 | 必要 | 值 |
|---|---|---|---|---|
| conf | 基本值設定，currentConfig 可以重設為此設定。 | 字典 | 必要 | 任何值，關於安全陣列 |
注意：（預設：目前的 siteConfig）（選用，預設為 getSiteConfig()）
參數
| 名稱 | 類型 | 預設值 | 描述 |
|---|---|---|---|
config | MermaidConfig | siteConfig | 基本值設定，currentConfig 可以重設為此設定。預設為目前的 siteConfig（例如，由 getSiteConfig 回傳）。 |
回傳
void
定義於
packages/mermaid/src/config.ts:221
sanitize
▸ sanitize(options): void
sanitize
| 函式 | 描述 | 類型 | 值 |
|---|---|---|---|
| sanitize | 將 siteConfig 設定為所需的值。 | Put 請求 | 無 |
確保選項參數不會嘗試覆寫 siteConfig 安全金鑰 注意：就地修改選項
參數
| 名稱 | 類型 | 描述 |
|---|---|---|
options | any | 潛在的 setConfig 參數 |
回傳
void
定義於
packages/mermaid/src/config.ts:146
saveConfigFromInitialize
▸ saveConfigFromInitialize(conf): void
參數
| 名稱 | 類型 |
|---|---|
conf | MermaidConfig |
回傳
void
定義於
packages/mermaid/src/config.ts:75
setConfig
▸ setConfig(conf): MermaidConfig
setConfig
| 函式 | 描述 | 類型 | 值 |
|---|---|---|---|
| setSiteConfig | 將 siteConfig 設定為所需的值 | Put 請求 | 任何值，除了安全陣列中的值 |
注意：設定 currentConfig。參數 conf 會根據 siteConfig.secure 金鑰進行清理。在 conf 中找到的任何具有 siteConfig.secure 中找到的金鑰的值，都將被替換為對應的 siteConfig 值。
參數
| 名稱 | 類型 | 描述 |
|---|---|---|
conf | MermaidConfig | 潛在的 currentConfig |
回傳
與清理後的 conf 合併的 currentConfig
定義於
packages/mermaid/src/config.ts:113
setSiteConfig
▸ setSiteConfig(conf): MermaidConfig
setSiteConfig
| 函式 | 描述 | 類型 | 值 |
|---|---|---|---|
| setSiteConfig | 將 siteConfig 設定為所需的值 | Put 請求 | 任何值，除了安全陣列中的值 |
注意：設定 siteConfig。siteConfig 是受保護的設定，用於重複使用。呼叫 reset() 會將 currentConfig 重設為 siteConfig。呼叫 reset(configApi.defaultConfig) 會將 siteConfig 和 currentConfig 重設為 defaultConfig 注意：currentConfig 是在此函式中設定的 預設值：在預設情況下，將反映全域設定
參數
| 名稱 | 類型 | 描述 |
|---|---|---|
conf | MermaidConfig | 要用作 siteConfig 的基本 currentConfig |
回傳
新的 siteConfig
定義於
packages/mermaid/src/config.ts:61
updateCurrentConfig
▸ updateCurrentConfig(siteCfg, _directives): MermaidConfig
參數
| 名稱 | 類型 |
|---|---|
siteCfg | MermaidConfig |
_directives | MermaidConfig[] |
回傳
定義於
packages/mermaid/src/config.ts:15
updateSiteConfig
▸ updateSiteConfig(conf): MermaidConfig
參數
| 名稱 | 類型 |
|---|---|
conf | MermaidConfig |