Class EsComment

Code comment. Either multi-line or single-line.

Hierarchy

EsComment

Implements

EsPrinter

Index

Constructors

Accessors

lineCount empty

Methods

appendTo printTo toString from

Constructors

constructor

new EsComment(...lines): EsComment
Constructs comment.
Parameters
- Rest ...lines: string[]
  
  Lines of comment text.
Returns EsComment
- Defined in ucnot/esgen/src/code/es-comment.ts:46

Accessors

lineCount

get lineCount(): number
Comment line count. When 0 the comment is considered empty.

Returns number
- Defined in ucnot/esgen/src/code/es-comment.ts:53

`Static` empty

get empty(): EsComment
Empty comment. I.e. comment with zero lines.

Returns EsComment
- Defined in ucnot/esgen/src/code/es-comment.ts:11

Methods

appendTo

appendTo(commented, prefix?): string
Appends comment to some code.
Parameters
- commented: string
  
  Code to comment.
- Optional prefix: string
  
  Optional comment prefix
Returns string
Commented code.
- Defined in ucnot/esgen/src/code/es-comment.ts:91

printTo

printTo(out): void
Prints block comment to the given code output.

Does nothing if comment is empty.
Parameters
- out: EsOutput
  
  Code output.
Returns void
Implementation of EsPrinter.printTo
- Defined in ucnot/esgen/src/code/es-comment.ts:64

toString

toString(prefix?): string
Builds a string representation of this comment.
Parameters
- Optional prefix: string
  
  A prefix to place to comment text.
Returns string
String containing block comment.
- Defined in ucnot/esgen/src/code/es-comment.ts:102

`Static` from

from(input?): EsComment
Converts the given input into comment.

Splits input onto lines.

Converts empty input to empty comment.

Returns the input comment instance as is.
Parameters
- Optional input: string | EsComment
  
  Comment input.
Returns EsComment
Comment instance.
- Defined in ucnot/esgen/src/code/es-comment.ts:28

Generated using TypeDoc