marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-19 15:30:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update 8.6.0_docs.md

Browse Source
This commit is contained in:
Neil Cuzon
2020-07-14 19:33:06 -07:00
committed by GitHub
parent 66ee81c55f
commit 5d4583c77f
1 changed files with 20 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/8.6.0_docs.md
View File

@@ -128,9 +128,9 @@ Example of **object.Assign**:
## setSiteConfig ## setSiteConfig
| Function | Description | Type | Values | | Function | Description | Type | Values |Parameters|Returns|
| --------- | ------------------- | ------- | ------------------ | | --------- | ------------------- | ------- | ------------------ | ------------------ | ------------------ |
| setSiteConfig|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array| | setSiteConfig|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array|conf|siteConfig|
**Notes: **Notes:
Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset
@@ -139,14 +139,14 @@ Example of **object.Assign**:
Note: currentConfig is set in this function Note: currentConfig is set in this function
Default value: At default, will mirror Global Config Default value: At default, will mirror Global Config
| Parameter | Description |Type | Required | Values|
| --- | --- | --- | --- | --- |
| conf| base set of values, which currentConfig coul be reset to.| Dictionary | Required | Any Values, with respect to the secure Array|
@param conf - the base currentConfig to use as siteConfig @param conf - the base currentConfig to use as siteConfig
@returns { } - the siteConfig @returns { } - the siteConfig
export const setSiteConfig = conf => {
assignWithDepth(currentConfig, conf, { clobber: true });
assignWithDepth(siteConfig, conf);
return getSiteConfig();
};
## getSiteConfig ## getSiteConfig
| Function | Description | Type | Values | | Function | Description | Type | Values |
@@ -157,9 +157,6 @@ export const setSiteConfig = conf => {
Returns any values in siteConfig. Returns any values in siteConfig.
@returns { } @returns { }
export const getSiteConfig = () => {
return assignWithDepth({}, siteConfig);
};
## setConfig ## setConfig
| Function | Description | Type | Values | | Function | Description | Type | Values |
@@ -170,7 +167,8 @@ export const getSiteConfig = () => {
**Notes : **Notes :
Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure keys. Any 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 values found in conf with key found in siteConfig.secure will be replaced with the corresponding
siteConfig value. siteConfig value.**
@param conf - the potential currentConfig @param conf - the potential currentConfig
@returns { } - the currentConfig merged with the sanitized conf @returns { } - the currentConfig merged with the sanitized conf
@@ -182,25 +180,24 @@ export const getSiteConfig = () => {
| getConfig |Obtains the currentConfig | Get Request | Any Values from currentConfig| | getConfig |Obtains the currentConfig | Get Request | Any Values from currentConfig|
**Notes : **Notes :
Returns any values in the currentConfig Returns any values in currentConfig.**
## sanitize ## sanitize
| Function | Description | Type | Values | | Function | Description | Type | Values |
| --------- | ------------------- | ------- | ------------------ | | --------- | ------------------- | ------- | ------------------ |
| sanitize |Sets the siteConfig to desired values. | Put Request |None| | sanitize |Sets the siteConfig to desired values. | Put Request(?) |None|
Ensures options parameter does not attempt to override siteConfig secure keys
Note: modifies options in-place
**Note: modifies options in-place
Ensures options parameter does not attempt to override siteConfig secure keys.**
## reset ## reset
| Function | Description | Type | Required | Values | | Function | Description | Type | Required | Values |Parameter|
| --------- | ------------------- | ------- | -------- | ------------------ | | --------- | -------------------| ------- | -------- | ------------------ |---------|
| reset|Resets currentConfig to conf| Put Request | Required | None| | reset|Resets currentConfig to conf| Put Request | Required | None| conf|
## onf ## conf
| Parameter | Description |Type | Required | Values| | Parameter | Description |Type | Required | Values|
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| conf| base set of values, which currentConfig coul be reset to.| Dictionary | Required | Any Values, with respect to the secure Array| | conf| base set of values, which currentConfig coul be reset to.| Dictionary | Required | Any Values, with respect to the secure Array|
@@ -209,4 +206,4 @@ export const getSiteConfig = () => {
default: current siteConfig (optional, default `getSiteConfig()`) default: current siteConfig (optional, default `getSiteConfig()`)
@param conf - the base currentConfig to reset to (default: current siteConfig ) @param conf - the base currentConfig to reset to (default: current siteConfig )
## for more information, read [Setup](https://mermaid-js.github.io/mermaid/#/Setup) ## for more information, read [Setup](https://mermaid-js.github.io/mermaid/#/Setup).