marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-18 14:59:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: Rename types to MermaidConfig and MermaidConfigWithDefaults

Browse Source
This commit is contained in:
Sidharth Vinod
2024-05-22 23:56:30 +05:30
parent 159d85e7f7
commit ea7d28bf1c
31 changed files with 218 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/config/setup/modules/config.md
View File

@@ -10,7 +10,7 @@
### defaultConfig
• `Const` **defaultConfig**: `MermaidConfig`
• `Const` **defaultConfig**: `MermaidConfigWithDefaults`
#### Defined in
@@ -26,9 +26,9 @@ Pushes in a directive to the configuration
#### Parameters
| Name | Type | Description |
| :---------- | :--------------------------------------- | :----------------------- |
| `directive` | `PartialObjectDeep`<`MermaidConfig`, {}> | The directive to push in |
| Name | Type | Description |
| :---------- | :--------------------------------------------------- | :----------------------- |
| `directive` | `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}> | The directive to push in |
#### Returns
@@ -42,7 +42,7 @@ Pushes in a directive to the configuration
### getConfig
▸ **getConfig**(): `MermaidConfig`
▸ **getConfig**(): `MermaidConfigWithDefaults`
## getConfig
@@ -54,7 +54,7 @@ Pushes in a directive to the configuration
#### Returns
`MermaidConfig`
`MermaidConfigWithDefaults`
The currentConfig
@@ -66,7 +66,7 @@ The currentConfig
### getSiteConfig
▸ **getSiteConfig**(): `MermaidConfig`
▸ **getSiteConfig**(): `MermaidConfigWithDefaults`
## getSiteConfig
@@ -78,7 +78,7 @@ The currentConfig
#### Returns
`MermaidConfig`
`MermaidConfigWithDefaults`
The siteConfig
@@ -108,9 +108,9 @@ The siteConfig
#### 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](config.md#getsiteconfig)). |
| Name | Type | Default value | Description |
| :------- | :-------------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `config` | `MermaidConfigWithDefaults` | `siteConfig` | base set of values, which currentConfig could be **reset** to. Defaults to the current siteConfig (e.g returned by [getSiteConfig](config.md#getsiteconfig)). |
#### Returns
@@ -157,9 +157,9 @@ options in-place
#### Parameters
| Name | Type |
| :----- | :--------------------------------------- |
| `conf` | `PartialObjectDeep`<`MermaidConfig`, {}> |
| Name | Type |
| :----- | :--------------------------------------------------- |
| `conf` | `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}> |
#### Returns
@@ -173,7 +173,7 @@ options in-place
### setConfig
▸ **setConfig**(`conf`): `MermaidConfig`
▸ **setConfig**(`conf`): `MermaidConfigWithDefaults`
## setConfig
@@ -187,13 +187,13 @@ corresponding siteConfig value.
#### Parameters
| Name | Type | Description |
| :----- | :--------------------------------------- | :-------------------------- |
| `conf` | `PartialObjectDeep`<`MermaidConfig`, {}> | The potential currentConfig |
| Name | Type | Description |
| :----- | :--------------------------------------------------- | :-------------------------- |
| `conf` | `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}> | The potential currentConfig |
#### Returns
`MermaidConfig`
`MermaidConfigWithDefaults`
The currentConfig merged with the sanitized conf
@@ -205,7 +205,7 @@ The currentConfig merged with the sanitized conf
### setSiteConfig
▸ **setSiteConfig**(`conf`): `MermaidConfig`
▸ **setSiteConfig**(`conf`): `MermaidConfigWithDefaults`
## setSiteConfig
@@ -220,13 +220,13 @@ function _Default value: At default, will mirror Global Config_
#### Parameters
| Name | Type | Description |
| :----- | :--------------------------------------- | :------------------------------------------ |
| `conf` | `PartialObjectDeep`<`MermaidConfig`, {}> | The base currentConfig to use as siteConfig |
| Name | Type | Description |
| :----- | :--------------------------------------------------- | :------------------------------------------ |
| `conf` | `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}> | The base currentConfig to use as siteConfig |
#### Returns
`MermaidConfig`
`MermaidConfigWithDefaults`
The new siteConfig
@@ -238,18 +238,18 @@ The new siteConfig
### updateCurrentConfig
▸ **updateCurrentConfig**(`siteCfg`, `_directives`): `MermaidConfig`
▸ **updateCurrentConfig**(`siteCfg`, `_directives`): `MermaidConfigWithDefaults`
#### Parameters
| Name | Type |
| :------------ | :------------------------------------------ |
| `siteCfg` | `MermaidConfig` |
| `_directives` | `PartialObjectDeep`<`MermaidConfig`, {}>\[] |
| Name | Type |
| :------------ | :------------------------------------------------------ |
| `siteCfg` | `MermaidConfigWithDefaults` |
| `_directives` | `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}>\[] |
#### Returns
`MermaidConfig`
`MermaidConfigWithDefaults`
#### Defined in
@@ -259,17 +259,17 @@ The new siteConfig
### updateSiteConfig
▸ **updateSiteConfig**(`conf`): `MermaidConfig`
▸ **updateSiteConfig**(`conf`): `MermaidConfigWithDefaults`
#### Parameters
| Name | Type |
| :----- | :--------------------------------------- |
| `conf` | `PartialObjectDeep`<`MermaidConfig`, {}> |
| Name | Type |
| :----- | :--------------------------------------------------- |
| `conf` | `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}> |
#### Returns
`MermaidConfig`
`MermaidConfigWithDefaults`
#### Defined in

2
docs/config/setup/modules/defaultConfig.md
View File

@@ -20,7 +20,7 @@
### default
• `Const` **default**: `RequiredDeep`<`MermaidConfig`>
• `Const` **default**: `RequiredDeep`<`MermaidConfigWithDefaults`>
Default mermaid configuration options.

6
docs/config/setup/modules/mermaidAPI.md
View File

@@ -32,7 +32,7 @@ Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
### mermaidAPI
• `Const` **mermaidAPI**: `Readonly`<{ `defaultConfig`: `MermaidConfig` = configApi.defaultConfig; `getConfig`: () => `MermaidConfig` = configApi.getConfig; `getDiagramFromText`: (`text`: `string`, `metadata`: `Pick`<`DiagramMetadata`, `"title"`>) => `Promise`<`Diagram`> ; `getSiteConfig`: () => `MermaidConfig` = configApi.getSiteConfig; `globalReset`: () => `void` ; `initialize`: (`options`: `PartialObjectDeep`<`MermaidConfig`, {}>) => `void` ; `parse`: (`text`: `string`, `parseOptions`: [`ParseOptions`](../interfaces/mermaidAPI.ParseOptions.md) & { `suppressErrors`: `true` }) => `Promise`<[`ParseResult`](../interfaces/mermaidAPI.ParseResult.md) | `false`>(`text`: `string`, `parseOptions?`: [`ParseOptions`](../interfaces/mermaidAPI.ParseOptions.md)) => `Promise`<[`ParseResult`](../interfaces/mermaidAPI.ParseResult.md)> ; `render`: (`id`: `string`, `text`: `string`, `svgContainingElement?`: `Element`) => `Promise`<[`RenderResult`](../interfaces/mermaidAPI.RenderResult.md)> ; `reset`: () => `void` ; `setConfig`: (`conf`: `PartialObjectDeep`<`MermaidConfig`, {}>) => `MermaidConfig` = configApi.setConfig; `updateSiteConfig`: (`conf`: `PartialObjectDeep`<`MermaidConfig`, {}>) => `MermaidConfig` = configApi.updateSiteConfig }>
• `Const` **mermaidAPI**: `Readonly`<{ `defaultConfig`: `MermaidConfigWithDefaults` = configApi.defaultConfig; `getConfig`: () => `MermaidConfigWithDefaults` = configApi.getConfig; `getDiagramFromText`: (`text`: `string`, `metadata`: `Pick`<`DiagramMetadata`, `"title"`>) => `Promise`<`Diagram`> ; `getSiteConfig`: () => `MermaidConfigWithDefaults` = configApi.getSiteConfig; `globalReset`: () => `void` ; `initialize`: (`options`: `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}>) => `void` ; `parse`: (`text`: `string`, `parseOptions`: [`ParseOptions`](../interfaces/mermaidAPI.ParseOptions.md) & { `suppressErrors`: `true` }) => `Promise`<[`ParseResult`](../interfaces/mermaidAPI.ParseResult.md) | `false`>(`text`: `string`, `parseOptions?`: [`ParseOptions`](../interfaces/mermaidAPI.ParseOptions.md)) => `Promise`<[`ParseResult`](../interfaces/mermaidAPI.ParseResult.md)> ; `render`: (`id`: `string`, `text`: `string`, `svgContainingElement?`: `Element`) => `Promise`<[`RenderResult`](../interfaces/mermaidAPI.RenderResult.md)> ; `reset`: () => `void` ; `setConfig`: (`conf`: `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}>) => `MermaidConfigWithDefaults` = configApi.setConfig; `updateSiteConfig`: (`conf`: `PartialObjectDeep`<`MermaidConfigWithDefaults`, {}>) => `MermaidConfigWithDefaults` = configApi.updateSiteConfig }>
## mermaidAPI configuration defaults
@@ -169,7 +169,7 @@ Create the user styles
| Name | Type | Description |
| :---------- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------ |
| `config` | `MermaidConfig` | configuration that has style and theme settings to use |
| `config` | `MermaidConfigWithDefaults` | configuration that has style and theme settings to use |
| `classDefs` | `undefined` \| `null` \| `Record`<`string`, `DiagramStyleClassDef`> | the classDefs in the diagram text. Might be null if none were defined. Usually is the result of a call to getClasses(...) |
#### Returns
@@ -192,7 +192,7 @@ the string with all the user styles
| Name | Type |
| :---------- | :-------------------------------------------------------- |
| `config` | `MermaidConfig` |
| `config` | `MermaidConfigWithDefaults` |
| `graphType` | `string` |
| `classDefs` | `undefined` \| `Record`<`string`, `DiagramStyleClassDef`> |
| `svgId` | `string` |