Class DocNode

Generates a TypeScript document.

This is the root node for a document.

Hierarchy

DocNode

Implements

Node

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DocNode(): DocNode

Returns DocNode

Properties

Private Readonly #nodes

#nodes: Map<string, InterfaceNode | NamespaceNode | TypeGuardNode> = ...

Readonly comment

comment: DocCommentNode = ...

Readonly import

import: HaystackCoreImportNode = ...

Readonly newLines

newLines: 0 = 0

The number of extra new lines added after the node has generated code.

Methods

Private addAllValuesToImport

addAllValuesToImport(): void

- Defined in src/nodes/DocNode.ts:47
Returns void

addInterface

addInterface(intNode: InterfaceNode): void

- Defined in src/nodes/DocNode.ts:30
Parameters
- intNode: InterfaceNode
Returns void

addNamespace

addNamespace(nsNode: NamespaceNode): void

- Defined in src/nodes/DocNode.ts:34
Parameters
- nsNode: NamespaceNode
Returns void

addTypeGuard

addTypeGuard(tgNode: TypeGuardNode): void

- Defined in src/nodes/DocNode.ts:38
Parameters
- tgNode: TypeGuardNode
Returns void

generateCode

generateCode(out: (code: string) => void): void

Implementation of Node.generateCode
- Defined in src/nodes/DocNode.ts:42
Generate the code.

Parameters
- out: (code: string) => void
  - - (code: string): void
    - Parameters
      - code: string
      Returns void
Returns void

Generated using TypeDoc