mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-09 02:27:05 +02:00
37 lines
950 B
Markdown
37 lines
950 B
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/config/functions/sanitize.md](../../../../../packages/mermaid/src/docs/config/setup/config/functions/sanitize.md).
|
|
|
|
[**mermaid**](../../README.md)
|
|
|
|
---
|
|
|
|
# Function: sanitize()
|
|
|
|
> **sanitize**(`options`): `void`
|
|
|
|
Defined in: [packages/mermaid/src/config.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L146)
|
|
|
|
## 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
|
|
|
|
### options
|
|
|
|
`any`
|
|
|
|
The potential setConfig parameter
|
|
|
|
## Returns
|
|
|
|
`void`
|