Class Block

constructor

• new Block(parentBlock): Block

• Parameters

  • parentBlock: undefined | Block

  Returns Block

entries

file

• get file(): TsFile

• Access the file

  Returns TsFile

length

• get length(): number

• Returns number

parent

• get parent(): Block

• Access the (required) parent

  Returns Block

add

• add(...entries): Block

• Add entries. Each entry will be serialized using toString()

  Parameters

  • Rest...entries: Entry[]

  Returns Block

atom

• atom(labelOrText, text?): Atom

• Add a statement or expression that will be automatically delimited

  Parameters

  • labelOrText: any
  • Optionaltext: any

  Returns Atom

blank

• blank(): Block

• Add a blank line

  Returns Block

builder

• builder(initialAtom?): BuilderBlock

• Add a builder-style block

  Parameters

  • OptionalinitialAtom: string

  Returns BuilderBlock

expressions

• expressions(prefix, suffix): ExpressionBlock

• Add a comma-delimited block

  Parameters

  • prefix: string
  • suffix: string

  Returns ExpressionBlock

get

• get(index): Entry

• Parameters

  • index: number

  Returns Entry

indexOf

• indexOf(entry): number

• Parameters

  • entry: Entry

  Returns number

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

layOutEntries

• layOutEntries(linePrefix, serializedEntries, rawEntries): string

• Parameters

  • linePrefix: string
  • serializedEntries: string[]
  • rawEntries: Entry[]

  Returns string

nameDefined

• nameDefined(name): void

• This is just a helper for guarding against duplicate definitions

  Parameters

  • name: string

  Returns void

raw

• raw(text): Block

• Add raw text

  Parameters

  • text: any

  Returns Block

remove

• remove(): void

• Delete from parent

  Returns void

section

• section(): Block

• Add a save point that allows for out-of-order insertion

  Returns Block

serialize

• serialize(linePrefix?): string

• Parameters

  • linePrefix: string = ""

  Returns string

splice

• splice(start, deleteCount?): Entry[]

• Parameters

  • start: number
  • OptionaldeleteCount: number

  Returns Entry[]

statements

• statements(prefix?, suffix?): StatementBlock

• Add a block with separate statements terminated by ";"

  Parameters

  • prefix: string = ""
  • suffix: string = ""

  Returns StatementBlock

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

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