7f2902594c
* develop: (59 commits) docs: Update mermaid.init remove date docs: Remove incorrect = chore: Prettier format chore: Update config.type.ts chore Add vitest.workspace.js chore: Stricter TS version chore: Remove MermaidAPI from docs doc: Update deprecation message doc: Update deprecation message fix: prevent escaping label styles chore: update browsers list chore(deps): update all patch dependencies docs: Added demo diagram of bidirectional arrows for sequence diagrams fix(deps): update all patch dependencies chore: Update drupal regex chore: Update pnpm chore: Update docs to remove html tag like text rebuild chore: Use string templates chore: Update docs ...
9.4 KiB
Warning
THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
Please edit the corresponding file in /packages/mermaid/src/docs/config/setup/modules/config.md.
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 |
The directive to push in |
Returns
void
Defined in
packages/mermaid/src/config.ts:188
getConfig
▸ getConfig(): MermaidConfig
getConfig
| Function | Description | Type | Return Values |
|---|---|---|---|
| getConfig | Obtains the currentConfig | Get Request | Any Values from current Config |
Notes: Avoid calling this function repeatedly. Instead, store the result in a variable and use it, and pass it down to function calls.
Returns
The currentConfig
Defined in
packages/mermaid/src/config.ts:131
getSiteConfig
▸ getSiteConfig(): MermaidConfig
getSiteConfig
| Function | Description | Type | Values |
|---|---|---|---|
| setSiteConfig | Returns the current siteConfig base configuration | Get Request | Returns Any Values in siteConfig |
Notes: Returns any values in siteConfig.
Returns
The siteConfig
Defined in
packages/mermaid/src/config.ts:96
reset
▸ reset(config?): void
reset
| Function | Description | Type | Required | Values |
|---|---|---|---|---|
| reset | Resets currentConfig to conf | Put Request | Required | None |
conf
| Parameter | Description | Type | Required | Values |
|---|---|---|---|---|
| conf | base set of values, which currentConfig could be reset to. | Dictionary | Required | Any Values, with respect to the secure Array |
Notes: (default: current siteConfig ) (optional, default getSiteConfig())
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
config |
MermaidConfig |
siteConfig |
base set of values, which currentConfig could be reset to. Defaults to the current siteConfig (e.g returned by getSiteConfig). |
Returns
void
Defined in
packages/mermaid/src/config.ts:221
sanitize
▸ sanitize(options): void
sanitize
| Function | Description | Type | Values |
|---|---|---|---|
| sanitize | Sets the siteConfig to desired values. | Put Request | None |
Ensures options parameter does not attempt to override siteConfig secure keys Notes: modifies options in-place
Parameters
| Name | Type | Description |
|---|---|---|
options |
any |
The potential setConfig parameter |
Returns
void
Defined in
packages/mermaid/src/config.ts:146
saveConfigFromInitialize
▸ saveConfigFromInitialize(conf): void
Parameters
| Name | Type |
|---|---|
conf |
MermaidConfig |
Returns
void
Defined in
packages/mermaid/src/config.ts:75
setConfig
▸ setConfig(conf): MermaidConfig
setConfig
| Function | Description | Type | Values |
|---|---|---|---|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
Notes: Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure keys. Any values found in conf with key found in siteConfig.secure will be replaced with the corresponding siteConfig value.
Parameters
| Name | Type | Description |
|---|---|---|
conf |
MermaidConfig |
The potential currentConfig |
Returns
The currentConfig merged with the sanitized conf
Defined in
packages/mermaid/src/config.ts:113
setSiteConfig
▸ setSiteConfig(conf): MermaidConfig
setSiteConfig
| Function | Description | Type | Values |
|---|---|---|---|
| setSiteConfig | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array |
Notes: Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset the currentConfig to siteConfig. Calls to reset(configApi.defaultConfig) will reset siteConfig and currentConfig to the defaultConfig Note: currentConfig is set in this function Default value: At default, will mirror Global Config
Parameters
| Name | Type | Description |
|---|---|---|
conf |
MermaidConfig |
The base currentConfig to use as siteConfig |
Returns
The new siteConfig
Defined in
packages/mermaid/src/config.ts:61
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 |