mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-01-28 07:03:17 +08:00
Update config.js
This commit is contained in:
parent
2b9960e05f
commit
1878e39dfc
@ -820,10 +820,19 @@ const siteConfig = assignWithDepth({}, defaultConfig);
|
|||||||
const currentConfig = assignWithDepth({}, defaultConfig);
|
const currentConfig = assignWithDepth({}, defaultConfig);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
*## 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
|
*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
|
*the currentConfig to siteConfig. Calls to reset(configApi.defaultConfig) will reset siteConfig and currentConfig
|
||||||
*to the defaultConfig
|
*to the defaultConfig
|
||||||
*Note: currentConfig is set in this function
|
*Note: currentConfig is set in this function
|
||||||
|
|
||||||
|
**Default value: At default, will mirror Global Config**
|
||||||
* @param conf - the base currentConfig to use as siteConfig
|
* @param conf - the base currentConfig to use as siteConfig
|
||||||
* @returns {*} - the siteConfig
|
* @returns {*} - the siteConfig
|
||||||
*/
|
*/
|
||||||
@ -833,14 +842,27 @@ export const setSiteConfig = conf => {
|
|||||||
return getSiteConfig();
|
return getSiteConfig();
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
* Obtains the current siteConfig base configuration
|
*## 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 {*}
|
* @returns {*}
|
||||||
*/
|
*/
|
||||||
export const getSiteConfig = () => {
|
export const getSiteConfig = () => {
|
||||||
return assignWithDepth({}, siteConfig);
|
return assignWithDepth({}, siteConfig);
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
* Sets the currentConfig. The param conf is sanitized based on the siteConfig.secure keys. Any
|
*## 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
|
*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
|
||||||
@ -852,13 +874,24 @@ export const setConfig = conf => {
|
|||||||
return getConfig();
|
return getConfig();
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
* Obtains the currentConfig
|
* ## getConfig
|
||||||
|
*| Function | Description | Type | Return Values |
|
||||||
|
*| --------- | ------------------- | ------- | ------------------ |
|
||||||
|
*| getConfig |Obtains the currentConfig | Get Request | Any Values from currentConfig|
|
||||||
|
|
||||||
|
***Notes**:
|
||||||
|
*Returns **any** the currentConfig
|
||||||
* @returns {*} - the currentConfig
|
* @returns {*} - the currentConfig
|
||||||
*/
|
*/
|
||||||
export const getConfig = () => {
|
export const getConfig = () => {
|
||||||
return assignWithDepth({}, currentConfig);
|
return assignWithDepth({}, currentConfig);
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
|
*## 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
|
*Ensures options parameter does not attempt to override siteConfig secure keys
|
||||||
*Note: modifies options in-place
|
*Note: modifies options in-place
|
||||||
* @param options - the potential setConfig parameter
|
* @param options - the potential setConfig parameter
|
||||||
@ -877,7 +910,18 @@ export const sanitize = options => {
|
|||||||
});
|
});
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
* Resets this currentConfig to conf
|
* ## reset
|
||||||
|
|
||||||
|
*| Function | Description | Type | Required | Values |
|
||||||
|
*| --------- | ------------------- | ------- | -------- | ------------------ |
|
||||||
|
*| reset|Resets currentConfig to conf| Put Request | Required | None|
|
||||||
|
*
|
||||||
|
*| 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|
|
||||||
|
*
|
||||||
|
**Notes :
|
||||||
|
(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 )
|
||||||
*/
|
*/
|
||||||
export const reset = (conf = getSiteConfig()) => {
|
export const reset = (conf = getSiteConfig()) => {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user