diff --git a/docs/8.6.0_docs.md b/docs/8.6.0_docs.md index 8b6b20ecd..02262a9e8 100644 --- a/docs/8.6.0_docs.md +++ b/docs/8.6.0_docs.md @@ -128,9 +128,9 @@ Example of **object.Assign**: ## setSiteConfig - | Function | Description | Type | Values | - | --------- | ------------------- | ------- | ------------------ | - | setSiteConfig|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array| + | Function | Description | Type | Values |Parameters|Returns| + | --------- | ------------------- | ------- | ------------------ | ------------------ | ------------------ | + | setSiteConfig|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array|conf|siteConfig| **Notes: 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 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 @returns { } - the siteConfig -export const setSiteConfig = conf => { - assignWithDepth(currentConfig, conf, { clobber: true }); - assignWithDepth(siteConfig, conf); - return getSiteConfig(); -}; ## getSiteConfig | Function | Description | Type | Values | @@ -157,9 +157,6 @@ export const setSiteConfig = conf => { Returns any values in siteConfig. @returns { } -export const getSiteConfig = () => { - return assignWithDepth({}, siteConfig); -}; ## setConfig | Function | Description | Type | Values | @@ -170,7 +167,8 @@ export const getSiteConfig = () => { **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. + siteConfig value.** + @param conf - the potential currentConfig @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| **Notes : - Returns any values in the currentConfig + Returns any values in currentConfig.** ## 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 - | Function | Description | Type | Required | Values | - | --------- | ------------------- | ------- | -------- | ------------------ | - | reset|Resets currentConfig to conf| Put Request | Required | None| + | Function | Description | Type | Required | Values |Parameter| + | --------- | -------------------| ------- | -------- | ------------------ |---------| + | reset|Resets currentConfig to conf| Put Request | Required | None| conf| - ## onf + ## conf | 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| @@ -209,4 +206,4 @@ export const getSiteConfig = () => { default: current siteConfig (optional, default `getSiteConfig()`) @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).