TypeDocConfig

@codification/cutwater-build-core > TypeDocConfig

Interface

beta:

Hierarchy

TypeDocConfig

↳ MarkdownTypeDocConfig

Properties

• entryPoint
• exclude
• excludeNotExported
• excludePrivate
• excludeProtected
• externalPattern
• gaId
• gitRevision
• hideGenerator
• ignoreCompilerErrors
• includeDeclarations
• includes
• json
• media
• mode
• module
• name
• options
• out
• plugin
• readme
• src
• target
• theme
• tsconfig

---

Properties

<Optional> entryPoint

● entryPoint: undefined | string

Defined in BaseTypeDocTask.ts:29

---

<Optional> exclude

● exclude: undefined | string

Defined in BaseTypeDocTask.ts:14

---

<Optional> excludeNotExported

● excludeNotExported: undefined | false | true

Defined in BaseTypeDocTask.ts:17

---

<Optional> excludePrivate

● excludePrivate: undefined | false | true

Defined in BaseTypeDocTask.ts:18

---

<Optional> excludeProtected

● excludeProtected: undefined | false | true

Defined in BaseTypeDocTask.ts:19

---

<Optional> externalPattern

● externalPattern: undefined | string

Defined in BaseTypeDocTask.ts:16

---

<Optional> gaId

● gaId: undefined | string

Defined in BaseTypeDocTask.ts:28

---

<Optional> gitRevision

● gitRevision: undefined | string

Defined in BaseTypeDocTask.ts:30

---

<Optional> hideGenerator

● hideGenerator: undefined | false | true

Defined in BaseTypeDocTask.ts:27

---

<Optional> ignoreCompilerErrors

● ignoreCompilerErrors: undefined | false | true

Defined in BaseTypeDocTask.ts:13

---

<Optional> includeDeclarations

● includeDeclarations: undefined | false | true

Defined in BaseTypeDocTask.ts:15

---

<Optional> includes

● includes: undefined | string

Defined in BaseTypeDocTask.ts:31

---

<Optional> json

● json: undefined | string

Defined in BaseTypeDocTask.ts:12

---

<Optional> media

● media: undefined | string

Defined in BaseTypeDocTask.ts:32

---

<Optional> mode

● mode: "file" | "modules"

Defined in BaseTypeDocTask.ts:10

---

<Optional> module

● module: "commonjs" | "amd" | "system" | "umd"

Defined in BaseTypeDocTask.ts:20

---

<Optional> name

● name: undefined | string

Defined in BaseTypeDocTask.ts:24

---

<Optional> options

● options: undefined | string

Defined in BaseTypeDocTask.ts:11

---

<Optional> out

● out: undefined | string

Defined in BaseTypeDocTask.ts:9

---

<Optional> plugin

● plugin: undefined | string

Defined in BaseTypeDocTask.ts:26

---

<Optional> readme

● readme: undefined | string

Defined in BaseTypeDocTask.ts:25

---

src

● src: string

Defined in BaseTypeDocTask.ts:8

---

<Optional> target

● target: "ES3" | "ES5" | "ES6"

Defined in BaseTypeDocTask.ts:21

---

<Optional> theme

● theme: undefined | string

Defined in BaseTypeDocTask.ts:23

---

<Optional> tsconfig

● tsconfig: undefined | string

Defined in BaseTypeDocTask.ts:22

---