Class HtmlCommentToken

An HTML comment token.

Hierarchy (View Summary)

HtmlToken
- HtmlCommentToken

Index

Constructors

Properties

kind comment isBogusComment isBangComment

Methods

toString writeTo

Constructors

constructor

new HtmlCommentToken(comment: string, bogus?: boolean): HtmlCommentToken
Creates a new HTML comment token.
Parameters
- comment: string
  The comment text.
- bogus: boolean = false
  true if the comment is bogus; otherwise, false.
Returns HtmlCommentToken

Throws
comment is null or undefined.
Overrides HtmlToken.constructor
- Defined in src/text/html-token.ts:56

Properties

`Readonly`kind

kind: HtmlTokenKind

The kind of HTML token that this object represents.

`Readonly`comment

comment: string

The comment text.

`Readonly`isBogusComment

isBogusComment: boolean

Whether the comment is a bogus comment.

isBangComment

isBangComment: boolean = false

internal

Methods

toString

toString(): string
Returns a string that represents the current HTML token.

Returns string
The serialized HTML token.
Inherited from HtmlToken.toString
- Defined in src/text/html-token.ts:33

writeTo

writeTo(output: TextWriter): void
Writes the HTML comment to a text writer.
Parameters
- output: TextWriter
  The output writer.
Returns void

Throws
output is null or undefined.
Overrides HtmlToken.writeTo
- Defined in src/text/html-token.ts:69