Class TsFile

Quick & dirty support for code gen. Less cumberson than e.g. TS compiler AST

Hierarchy (view full)

Block
- TsFile

Index

Constructors

Properties

entries indent name parentBlock prefix shouldGroup suffix

Accessors

basename file isDocumented length parent

Constructors

constructor

new TsFile(name, editable?): TsFile
Parameters
- name: string
- editable: boolean = false
Returns TsFile
Overrides Block.constructor
- Defined in codegen/src/util/TsFile.ts:611

Properties

entries

entries: Entry[] = ...

`Protected`indent

indent: string = ""

name

name: string

`Protected`parentBlock

parentBlock: undefined | Block

`Protected`prefix

prefix: string = ""

shouldGroup

shouldGroup: boolean = false

`Protected`suffix

suffix: string = ""

Accessors

basename

get basename(): string
Returns string
- Defined in codegen/src/util/TsFile.ts:634

file

get file(): TsFile
Access the file

Returns TsFile
Inherited from Block.file
- Defined in codegen/src/util/TsFile.ts:251

isDocumented

get isDocumented(): boolean
Returns boolean
Inherited from Block.isDocumented
- Defined in codegen/src/util/TsFile.ts:57

length

get length(): number
Returns number
Inherited from Block.length
- Defined in codegen/src/util/TsFile.ts:175

parent

get parent(): Block
Access the (required) parent

Returns Block
Inherited from Block.parent
- Defined in codegen/src/util/TsFile.ts:245

Methods

add

add(...entries): TsFile
Add entries. Each entry will be serialized using toString()
Parameters
- Rest...entries: Entry[]
Returns TsFile
Inherited from Block.add
- Defined in codegen/src/util/TsFile.ts:276

addImport

addImport(filename, name?, asExternal?): TsFile
Parameters
- filename: string
- Optionalname: string
- OptionalasExternal: string
Returns TsFile
- Defined in codegen/src/util/TsFile.ts:638

addReexport

addReexport(filename, ...symbols): void
Parameters
- filename: string
- Rest...symbols: string[]
Returns void
- Defined in codegen/src/util/TsFile.ts:665

atom

atom(labelOrText, text?): Atom
Add a statement or expression that will be automatically delimited
Parameters
- labelOrText: any
- Optionaltext: any
Returns Atom
Inherited from Block.atom
- Defined in codegen/src/util/TsFile.ts:348

blank

blank(): TsFile
Add a blank line

Returns TsFile
Inherited from Block.blank
- Defined in codegen/src/util/TsFile.ts:312

builder

builder(initialAtom?): BuilderBlock
Add a builder-style block
Parameters
- OptionalinitialAtom: string
Returns BuilderBlock
Inherited from Block.builder
- Defined in codegen/src/util/TsFile.ts:338

`Protected`delimiterAfter

delimiterAfter(entry, serialized): string
Parameters
- entry: Entry
- serialized: string
Returns string
Inherited from Block.delimiterAfter
- Defined in codegen/src/util/TsFile.ts:400

document

document(content, extra?): TsFile
Add a TsDoc style comment
Parameters
- content: string | Documentation
- Optionalextra: string
Returns TsFile
Inherited from Block.document
- Defined in codegen/src/util/TsFile.ts:67

expressions

expressions(prefix, suffix): ExpressionBlock
Add a comma-delimited block
Parameters
- prefix: string
- suffix: string
Returns ExpressionBlock
Inherited from Block.expressions
- Defined in codegen/src/util/TsFile.ts:331

get

get(index): Entry
Parameters
- index: number
Returns Entry
Inherited from Block.get
- Defined in codegen/src/util/TsFile.ts:187

indexOf

indexOf(entry): number
Parameters
- entry: Entry
Returns number
Inherited from Block.indexOf
- Defined in codegen/src/util/TsFile.ts:179

insertingBefore

insertingBefore<T>(before, fn): T
Execute logic with block configured for specific insertion point
Type Parameters
- T
Parameters
- before: Entry
- fn: (() => T)
  - - (): T
    - Returns T
Returns T
Inherited from Block.insertingBefore
- Defined in codegen/src/util/TsFile.ts:382

`Protected`isDelimited

isDelimited(entry): entry is NestedBlock | Atom
Parameters
- entry: Entry
Returns entry is NestedBlock | Atom
Inherited from Block.isDelimited
- Defined in codegen/src/util/TsFile.ts:417

layOutEntries

layOutEntries(linePrefix, serializedEntries, rawEntries): string
Parameters
- linePrefix: string
- serializedEntries: string[]
- rawEntries: Entry[]
Returns string
Inherited from Block.layOutEntries
- Defined in codegen/src/util/TsFile.ts:205

nameDefined

nameDefined(name): void
This is just a helper for guarding against duplicate definitions
Parameters
- name: string
Returns void
Inherited from Block.nameDefined
- Defined in codegen/src/util/TsFile.ts:393

raw

raw(text): TsFile
Add raw text
Parameters
- text: any
Returns TsFile
Inherited from Block.raw
- Defined in codegen/src/util/TsFile.ts:307

remove

remove(): void
Delete from parent

Returns void
Inherited from Block.remove
- Defined in codegen/src/util/TsFile.ts:260

save

save(): undefined | TsFile
Returns undefined | TsFile
- Defined in codegen/src/util/TsFile.ts:678

section

section(): Block
Add a save point that allows for out-of-order insertion

Returns Block
Inherited from Block.section
- Defined in codegen/src/util/TsFile.ts:317

serialize

serialize(linePrefix?): string
Parameters
- linePrefix: string = ""
Returns string
Inherited from Block.serialize
- Defined in codegen/src/util/TsFile.ts:191

splice

splice(start, deleteCount?): Entry[]
Parameters
- start: number
- OptionaldeleteCount: number
Returns Entry[]
Inherited from Block.splice
- Defined in codegen/src/util/TsFile.ts:183

statements

statements(prefix?, suffix?): StatementBlock
Add a block with separate statements terminated by ";"
Parameters
- prefix: string = ""
- suffix: string = ""
Returns StatementBlock
Inherited from Block.statements
- Defined in codegen/src/util/TsFile.ts:324

toString

toString(linePrefix?): string
Parameters
- linePrefix: string = ""
Returns string
Inherited from Block.toString
- Defined in codegen/src/util/TsFile.ts:77

undefine

undefine(name): void
Remove a name from the defined pool. This is necessary when e.g. defining a type and object with the same name.
Parameters
- name: string
Returns void
Inherited from Block.undefine
- Defined in codegen/src/util/TsFile.ts:271

value

value(value, prefix?, suffix?): undefined | ExpressionBlock | Atom
Add an atom or block that recreates the input value
Parameters
- value: any
- prefix: string = ""
- suffix: string = ""
Returns undefined | ExpressionBlock | Atom
Inherited from Block.value
- Defined in codegen/src/util/TsFile.ts:355