Interface: default
configs/interfaces/IDocumentOption.default
Hierarchy
Properties
components
• components: CE_OUTPUT_COMPONENT[]
define the output component to builded documents
Defined in
configs/interfaces/IDocumentOption.ts:10
config
• config: string
define the path to to configuration file: .erdiarc
Inherited from
Defined in
configs/interfaces/ICommonOption.ts:3
dataSourcePath
• dataSourcePath: string
define the path to TypeORM data source file
Inherited from
Defined in
configs/interfaces/ICommonOption.ts:9
databasePath
• Optional databasePath: string
define the directory to store erdiadb.json
Defined in
configs/interfaces/IDocumentOption.ts:21
format
• format: CE_OUTPUT_FORMAT
define the output format to builded documents
- html
- markdown
- image
Defined in
configs/interfaces/IDocumentOption.ts:37
output
• Optional output: string
define the directory to output file
Inherited from
Defined in
configs/interfaces/ICommonOption.ts:6
projectName
• projectName: CE_PROJECT_NAME_FROM
define whether project name will come from the package.json name field or database name
- db: database name from TypeORM
- app: application name from package.json
Defined in
configs/interfaces/IDocumentOption.ts:18
skipImageInHtml
• Optional skipImageInHtml: boolean
enabling the this option will skip attaching the ER diagram image file to the html document
Defined in
configs/interfaces/IDocumentOption.ts:27
templatePath
• Optional templatePath: string
define the directory to ETA templates. erdia are using ETA template engine
Defined in
configs/interfaces/IDocumentOption.ts:24
theme
• theme: CE_MERMAID_THEME
define the mermaid.js plugin theme
Url
https://mermaid-js.github.io/mermaid/#/Setup?id=theme
Defined in
configs/interfaces/IDocumentOption.ts:52
versionFrom
• versionFrom: CE_ENTITY_VERSION_FROM
define whether document version will come from the package.json version field or specific file, timestamp
Defined in
configs/interfaces/IDocumentOption.ts:42
versionPath
• Optional versionPath: string
If the versionFrom option set file, read the file from this path