Interface: default
configs/interfaces/IBuildCommandOption.default
Hierarchy
↳
default
Properties
backgroundColor
• Optional backgroundColor: string
define the background color to html documents. eg. transparent, red, '#F0F0F0'
Format
pdf, image
Defined in
configs/interfaces/IBuildCommandOption.ts:47
components
• components: CE_OUTPUT_COMPONENT[]
define the output component to builded documents
Inherited from
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
Inherited from
Defined in
configs/interfaces/IDocumentOption.ts:21
format
• format: CE_OUTPUT_FORMAT
define the output format to builded documents
- html
- markdown
- image
Inherited from
Defined in
configs/interfaces/IDocumentOption.ts:37
imageFormat
• Optional imageFormat: "svg" | "png"
define the format to image file
Format
image
Defined in
configs/interfaces/IBuildCommandOption.ts:53
output
• Optional output: string
define the directory to output file
Inherited from
Defined in
configs/interfaces/ICommonOption.ts:6
prettierConfig
• Optional prettierConfig: string
define the path to the prettier configuration file
Defined in
configs/interfaces/IBuildCommandOption.ts:17
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
Inherited from
Defined in
configs/interfaces/IDocumentOption.ts:18
puppeteerConfig
• Optional puppeteerConfig: string
define the path to the puppeteer configuration file
Format
html, pdf, image
Defined in
configs/interfaces/IBuildCommandOption.ts:23
routeBasePath
• Optional routeBasePath: string
define the route base path. The route base path is used as the base path for navbar anchor when generating HTML documents
Format
html
Defined in
configs/interfaces/IBuildCommandOption.ts:8
skipImageInHtml
• Optional skipImageInHtml: boolean
enabling the this option will skip attaching the ER diagram image file to the html document
Inherited from
Defined in
configs/interfaces/IDocumentOption.ts:27
templatePath
• Optional templatePath: string
define the directory to ETA templates. erdia are using ETA template engine
Inherited from
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
Inherited from
Defined in
configs/interfaces/IDocumentOption.ts:52
title
• Optional title: string
define what will be written in the HTML document title tag
Format
html
Defined in
configs/interfaces/IBuildCommandOption.ts:14
versionFrom
• versionFrom: CE_ENTITY_VERSION_FROM
define whether document version will come from the package.json version field or specific file, timestamp
Inherited from
Defined in
configs/interfaces/IDocumentOption.ts:42
versionPath
• Optional versionPath: string
If the versionFrom option set file, read the file from this path
Inherited from
Defined in
configs/interfaces/IDocumentOption.ts:45
viewportHeight
• Optional viewportHeight: number
define the viewport height to puppeteer. The width is defined by the HTML document css attribute height
Format
html, pdf, image
Defined in
configs/interfaces/IBuildCommandOption.ts:41
viewportWidth
• Optional viewportWidth: number
define the viewport width to puppeteer. The width is defined by the HTML document css attribute width
Format
html, pdf, image
Defined in
configs/interfaces/IBuildCommandOption.ts:35
width
• Optional width: string
define the ER diagram width. The width is defined by the HTML document css attribute width
Format
html, pdf, image