Class Comment<T, O>

Type Parameters

T extends RuleConfigValue
O extends PlainData = undefined

Hierarchy

MLCharacterData<T, O, MLASTComment>
- Comment

Implements

Comment

Index

Constructors

constructor

Constructors

constructor

new Comment<T, O>(astNode: MLASTComment, document: Document<T, O>): Comment<T, O>
Type Parameters
- T extends RuleConfigValue
- O extends PlainData = undefined
Parameters
- astNode: MLASTComment
- document: Document<T, O>
Returns Comment<T, O>
Inherited from MLCharacterData<T, O, MLASTComment>.constructor
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:167

Properties

`Private` #childNodes

#childNodes: undefined | NodeListOf<ChildNode<T, O>>

Cached childNodes property

`Private` `Readonly` #endCol

#endCol: number

`Private` `Readonly` #endLine

#endLine: number

`Private` `Readonly` #endOffset

#endOffset: number

`Private` #fixed

#fixed: string

`Private` `Readonly` #ownerDocument

#ownerDocument: Document<T, O>

Owner Document

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#ref-for-dom-node-ownerdocument

`Private` #prevToken

#prevToken: undefined | null | MLNode<T, O, MLASTAbstractNode>

Cached prevToken property

`Private` `Readonly` #raw

#raw: string

`Private` `Readonly` #startCol

#startCol: number

`Private` `Readonly` #startLine

#startLine: number

`Private` `Readonly` #startOffset

#startOffset: number

`Readonly` ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2 = 2

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4 = 4

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` COMMENT_NODE

COMMENT_NODE: 8 = 8

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11 = 11

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` DOCUMENT_NODE

DOCUMENT_NODE: 9 = 9

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16 = 0b10_000

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#dom-node-document_position_contained_by

`Readonly` DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8 = 0b1_000

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#dom-node-document_position_contains

`Readonly` DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1 = 0b1

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#dom-node-document_position_disconnected

`Readonly` DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4 = 0b100

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#dom-node-document_position_following

`Readonly` DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32 = 0b100_000

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#dom-node-document_position_implementation_specific

`Readonly` DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2 = 0b10

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#dom-node-document_position_preceding

`Readonly` DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10 = 10

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` ELEMENT_NODE

ELEMENT_NODE: 1 = 1

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` ENTITY_NODE

ENTITY_NODE: 6 = 6

Deprecated

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5 = 5

Deprecated

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` MARKUPLINT_PREPROCESSOR_BLOCK

MARKUPLINT_PREPROCESSOR_BLOCK: 101 = 101

Implements

@markuplint/ml-core API: MLNode

`Readonly` NOTATION_NODE

NOTATION_NODE: 12 = 12

Deprecated

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7 = 7

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Readonly` TEXT_NODE

TEXT_NODE: 3 = 3

Implements

DOM API: Node

See

https://dom.spec.whatwg.org/#interface-node

`Protected` _astToken

_astToken: MLASTComment

`Readonly` rules

rules: Record<string, AnyRule> = {}

`Readonly` uuid

uuid: string

Accessors

baseURI

get baseURI(): string
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-baseuri%E2%91%A0

Returns string
Implementation of Comment.baseURI

Inherited from MLCharacterData.baseURI
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:185

childNodes

get childNodes(): NodeListOf<ChildNode<T, O>>
The list of child nodes that contains Element, Text, and Comment.

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-childnodes%E2%91%A0

Returns NodeListOf<ChildNode<T, O>>
Implementation of Comment.childNodes

Inherited from MLCharacterData.childNodes
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:196

data

get data(): string
Implements
DOM API: CharacterData

See
https://dom.spec.whatwg.org/#dom-characterdata-data

Returns string
Implementation of Comment.data

Inherited from MLCharacterData.data
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:29

endCol

get endCol(): number
Implements
@markuplint/ml-core API: MLDOMToken

Returns number
Inherited from MLCharacterData.endCol
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:33

endLine

get endLine(): number
Implements
@markuplint/ml-core API: MLDOMToken

Returns number
Inherited from MLCharacterData.endLine
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:40

endOffset

get endOffset(): number
Implements
@markuplint/ml-core API: MLDOMToken

Returns number
Inherited from MLCharacterData.endOffset
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:47

firstChild

get firstChild(): null | ChildNode<T, O>
The first node that may be Element, Text, and CommentNode.

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-firstchild%E2%91%A0

Returns null | ChildNode<T, O>
Implementation of Comment.firstChild

Inherited from MLCharacterData.firstChild
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:239

isConnected

get isConnected(): boolean
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-isconnected%E2%91%A0

Returns boolean
Implementation of Comment.isConnected

Inherited from MLCharacterData.isConnected
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:250

lastChild

get lastChild(): null | ChildNode<T, O>
The last node that may be Element, Text, and CommentNode.

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-lastchild%E2%91%A0

Returns null | ChildNode<T, O>
Implementation of Comment.lastChild

Inherited from MLCharacterData.lastChild
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:261

length

get length(): number
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: CharacterData

See
https://dom.spec.whatwg.org/#dom-characterdata-length

Returns number
Implementation of Comment.length

Inherited from MLCharacterData.length
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:41

nextElementSibling

get nextElementSibling(): null | Element<T, O>
The element immediately following the specified one in its parent's children list.

Implements
DOM API: CharacterData

See
https://dom.spec.whatwg.org/#ref-for-dom-nondocumenttypechildnode-nextelementsibling%E2%91%A1

Returns null | Element<T, O>
Implementation of Comment.nextElementSibling

Inherited from MLCharacterData.nextElementSibling
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:52

nextNode

get nextNode(): null | MLNode<T, O, MLASTAbstractNode>
Implements
@markuplint/ml-core API: MLNode

Returns null | MLNode<T, O, MLASTAbstractNode>
Inherited from MLCharacterData.nextNode
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:268

nextSibling

get nextSibling(): null | ChildNode
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-nextsibling%E2%91%A0

Returns null | ChildNode
Implementation of Comment.nextSibling

Inherited from MLCharacterData.nextSibling
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:282

nodeName

get nodeName(): "#comment"
Returns a string appropriate for the type of node as Attr

See
https://dom.spec.whatwg.org/#ref-for-exclusive-text-node%E2%91%A0

Returns "#comment"
Implementation of Comment.nodeName

Overrides MLCharacterData.nodeName
- Defined in @markuplint/ml-core/src/ml-dom/node/comment.ts:16

nodeType

get nodeType(): 8
Returns a number appropriate for the type of Comment

Returns 8
Implementation of Comment.nodeType

Overrides MLCharacterData.nodeType
- Defined in @markuplint/ml-core/src/ml-dom/node/comment.ts:23

nodeValue

get nodeValue(): null | string
Returns null | string
Implementation of Comment.nodeValue

Inherited from MLCharacterData.nodeValue
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:56

originRaw

get originRaw(): string
Implements
@markuplint/ml-core API: MLDOMToken

Returns string
Inherited from MLCharacterData.originRaw
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:54

ownerDocument

get ownerDocument(): any
The Document that this node belongs to.

Deprecated

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-ownerdocument%E2%91%A0

Returns any
Implementation of Comment.ownerDocument

Inherited from MLCharacterData.ownerDocument
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:327

ownerMLDocument

get ownerMLDocument(): Document<T, O>
Returns Document<T, O>
Inherited from MLCharacterData.ownerMLDocument
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:331

parentElement

get parentElement(): null | Element<T, O>
The parent element.

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-parentelement%E2%91%A0

Returns null | Element<T, O>
Implementation of Comment.parentElement

Inherited from MLCharacterData.parentElement
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:341

parentNode

get parentNode(): null | Element<T, O> | Document<any, any> | DocumentFragment<any, any>
The parent node that may be Element, Document, DocumentFragment, and null.

HTML:
```
<html> // => #document
  <body></body> // => <html>
</html>
```
```
<div> // => null
  <span></span> // => <div>
</div>
```
JSX:
```
<> // => null
  <div> // => #document-fragment
    {items.map(item => {
      return (
        <span /> // => null
      )
    })}
  </div>
</>
```
Pug
```
//- null
div
  //- <div>
  if foo
    //- null
    span
```
Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-parentnode%E2%91%A0
Returns null | Element<T, O> | Document<any, any> | DocumentFragment<any, any>
Implementation of Comment.parentNode

Inherited from MLCharacterData.parentNode
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:399

prevNode

get prevNode(): null | MLNode<T, O, MLASTAbstractNode>
Implements
@markuplint/ml-core API: MLNode

Returns null | MLNode<T, O, MLASTAbstractNode>
Inherited from MLCharacterData.prevNode
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:422

prevToken

get prevToken(): null | MLNode<T, O, MLASTAbstractNode>
Implements
@markuplint/ml-core API: MLNode

Returns null | MLNode<T, O, MLASTAbstractNode>
Inherited from MLCharacterData.prevToken
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:432

previousElementSibling

get previousElementSibling(): null | Element<T, O>
The element immediately prior the specified one in its parent's children list.

Implements
DOM API: CharacterData

See
https://dom.spec.whatwg.org/#ref-for-dom-nondocumenttypechildnode-previouselementsibling%E2%91%A1

Returns null | Element<T, O>
Implementation of Comment.previousElementSibling

Inherited from MLCharacterData.previousElementSibling
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:67

previousSibling

get previousSibling(): null | ChildNode
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-previoussibling%E2%91%A0

Returns null | ChildNode
Implementation of Comment.previousSibling

Inherited from MLCharacterData.previousSibling
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:468

raw

get raw(): string
Implements
@markuplint/ml-core API: MLDOMToken

Returns string
Inherited from MLCharacterData.raw
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:61

rule

get rule(): RuleInfo<T, O>
Implements
@markuplint/ml-core API: MLNode

Returns RuleInfo<T, O>
Inherited from MLCharacterData.rule
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:475

startCol

get startCol(): number
Implements
@markuplint/ml-core API: MLDOMToken

Returns number
Inherited from MLCharacterData.startCol
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:68

startLine

get startLine(): number
Implements
@markuplint/ml-core API: MLDOMToken

Returns number
Inherited from MLCharacterData.startLine
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:75

startOffset

get startOffset(): number
Implements
@markuplint/ml-core API: MLDOMToken

Returns number
Inherited from MLCharacterData.startOffset
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:82

syntacticalParentNode

get syntacticalParentNode(): null | Element<T, O> | Block<T, O> | Document<any, any> | DocumentFragment<any, any>

Returns a syntactical parent node

HTML:

<html> // => #document
  <body></body> // => <html>
</html>

JSX:

<> // => #document
  <div> // => #document-fragment
    {items.map(item => {
      return (
        <span /> // => #ml-block
      )
    })}
  </div>
</>

Pug

//- #document
div
  //- <div>
  if foo
    //- #ml-block
    span

Implements

@markuplint/ml-core API: MLNode

Returns null | Element<T, O> | Block<T, O> | Document<any, any> | DocumentFragment<any, any>

textContent

get textContent(): null | string
Returns null | string
Implementation of Comment.textContent

Overrides MLCharacterData.textContent
- Defined in @markuplint/ml-core/src/ml-dom/node/comment.ts:27

Methods

addEventListener

addEventListener(type: string, callback?: null | EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: EventTarget

See
https://dom.spec.whatwg.org/#ref-for-dom-eventtarget-addeventlistener%E2%91%A2
Parameters
- type: string
- Optional callback: null | EventListenerOrEventListenerObject
- options: boolean | AddEventListenerOptions = {}
Returns void
Implementation of Comment.addEventListener

Inherited from MLCharacterData.addEventListener
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:566

after

after(...nodes: (string | Element<any, any>)[]): void
Implements
DOM API: CharacterData
Parameters
- Rest ...nodes: (string | Element<any, any>)[]
Returns void
Implementation of Comment.after

Inherited from MLCharacterData.after
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:74

appendChild

appendChild<T>(node: T): T
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-appendchild
Type Parameters
- T extends Node<T>
Parameters
- node: T
Returns T
Implementation of Comment.appendChild

Inherited from MLCharacterData.appendChild
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:582

appendData

appendData(data: string): void
Parameters
- data: string
Returns void
Implementation of Comment.appendData

Inherited from MLCharacterData.appendData
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:82

before

before(...nodes: (string | Element<any, any>)[]): void
Implements
DOM API: CharacterData
Parameters
- Rest ...nodes: (string | Element<any, any>)[]
Returns void
Implementation of Comment.before

Inherited from MLCharacterData.before
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:87

cloneNode

cloneNode(deep?: boolean): Node
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-clonenode%E2%91%A0
Parameters
- Optional deep: boolean
Returns Node
Implementation of Comment.cloneNode

Inherited from MLCharacterData.cloneNode
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:593

compareDocumentPosition

compareDocumentPosition(other: Node): number
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-comparedocumentposition%E2%91%A0
Parameters
- other: Node
Returns number
Implementation of Comment.compareDocumentPosition

Inherited from MLCharacterData.compareDocumentPosition
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:604

contains

contains(other: null | Node): boolean
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-contains%E2%91%A0
Parameters
- other: null | Node
Returns boolean
Implementation of Comment.contains

Inherited from MLCharacterData.contains
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:618

deleteData

deleteData(offset: number, count: number): void
Parameters
- offset: number
- count: number
Returns void
Implementation of Comment.deleteData

Inherited from MLCharacterData.deleteData
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:95

dispatchEvent

dispatchEvent(event: Event): boolean
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: EventTarget

See
https://dom.spec.whatwg.org/#ref-for-dom-eventtarget-dispatchevent%E2%91%A2
Parameters
- event: Event
Returns boolean
Implementation of Comment.dispatchEvent

Inherited from MLCharacterData.dispatchEvent
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:632

fix

fix(raw: string): void
Implements
@markuplint/ml-core API: MLDOMToken
Parameters
- raw: string
Returns void
Inherited from MLCharacterData.fix
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:89

getRootNode

getRootNode(options?: GetRootNodeOptions): MLNode<T, O, MLASTAbstractNode>
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-getrootnode%E2%91%A0
Parameters
- Optional options: GetRootNodeOptions
Returns MLNode<T, O, MLASTAbstractNode>
Implementation of Comment.getRootNode

Inherited from MLCharacterData.getRootNode
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:646

hasChildNodes

hasChildNodes(): boolean
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-haschildnodes%E2%91%A0

Returns boolean
Implementation of Comment.hasChildNodes

Inherited from MLCharacterData.hasChildNodes
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:664

insertBefore

insertBefore<T>(node: T, child: null | Node): T
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-insertbefore
Type Parameters
- T extends Node<T>
Parameters
- node: T
- child: null | Node
Returns T
Implementation of Comment.insertBefore

Inherited from MLCharacterData.insertBefore
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:675

insertData

insertData(offset: number, data: string): void
Parameters
- offset: number
- data: string
Returns void
Implementation of Comment.insertData

Inherited from MLCharacterData.insertData
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:98

is

is<NType>(nodeType: NType): this is NodeTypeOf<NType, T, O>
Implements
@markuplint/ml-core API: MLNode
Type Parameters
- NType extends NodeType
Parameters
- nodeType: NType
Returns this is NodeTypeOf<NType, T, O>
Inherited from MLCharacterData.is
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:686

isDefaultNamespace

isDefaultNamespace(namespace: null | string): boolean
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-isdefaultnamespace
Parameters
- namespace: null | string
Returns boolean
Implementation of Comment.isDefaultNamespace

Inherited from MLCharacterData.isDefaultNamespace
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:697

isEqualNode

isEqualNode(otherNode: null | Node): boolean
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-isequalnode%E2%91%A0
Parameters
- otherNode: null | Node
Returns boolean
Implementation of Comment.isEqualNode

Inherited from MLCharacterData.isEqualNode
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:708

isInFragmentDocument

isInFragmentDocument(): boolean
Implements
@markuplint/ml-core API: MLNode

Returns boolean
Inherited from MLCharacterData.isInFragmentDocument
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:718

isSameNode

isSameNode(otherNode: null | Node): boolean
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-issamenode
Parameters
- otherNode: null | Node
Returns boolean
Implementation of Comment.isSameNode

Inherited from MLCharacterData.isSameNode
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:729

lookupNamespaceURI

lookupNamespaceURI(prefix: null | string): null | string
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-lookupnamespaceuri
Parameters
- prefix: null | string
Returns null | string
Implementation of Comment.lookupNamespaceURI

Inherited from MLCharacterData.lookupNamespaceURI
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:743

lookupPrefix

lookupPrefix(namespace: null | string): null | string
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-lookupprefix
Parameters
- namespace: null | string
Returns null | string
Implementation of Comment.lookupPrefix

Inherited from MLCharacterData.lookupPrefix
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:754

normalize

normalize(): void
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#ref-for-dom-node-normalize%E2%91%A0

Returns void
Implementation of Comment.normalize

Inherited from MLCharacterData.normalize
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:765

remove

remove(): void
Implements
DOM API: CharacterData

Returns void
Implementation of Comment.remove

Inherited from MLCharacterData.remove
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:103

removeChild

removeChild<T>(child: T): T
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-removechild
Type Parameters
- T extends Node<T>
Parameters
- child: T
Returns T
Implementation of Comment.removeChild

Inherited from MLCharacterData.removeChild
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:776

removeEventListener

removeEventListener(type: string, callback?: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: EventTarget

See
https://dom.spec.whatwg.org/#ref-for-dom-eventtarget-removeeventlistener%E2%91%A1
Parameters
- type: string
- Optional callback: null | EventListenerOrEventListenerObject
- options: boolean | EventListenerOptions = {}
Returns void
Implementation of Comment.removeEventListener

Inherited from MLCharacterData.removeEventListener
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:787

replaceChild

replaceChild<T>(node: Node, child: T): T
IT THROWS AN ERROR WHEN CALLING THIS.

Unsupported

Implements
DOM API: Node

See
https://dom.spec.whatwg.org/#dom-node-replacechild
Type Parameters
- T extends Node<T>
Parameters
- node: Node
- child: T
Returns T
Implementation of Comment.replaceChild

Inherited from MLCharacterData.replaceChild
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:803

replaceData

replaceData(offset: number, count: number, data: string): void
Parameters
- offset: number
- count: number
- data: string
Returns void
Implementation of Comment.replaceData

Inherited from MLCharacterData.replaceData
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:108

replaceWith

replaceWith(...nodes: (string | Element<any, any>)[]): void
Implements
DOM API: CharacterData
Parameters
- Rest ...nodes: (string | Element<any, any>)[]
Returns void
Implementation of Comment.replaceWith

Inherited from MLCharacterData.replaceWith
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:113

resetChildren

resetChildren(childNodes?: NodeListOf<ChildNode<T, O>>): void
Implements
@markuplint/ml-core API: MLNode
Parameters
- Optional childNodes: NodeListOf<ChildNode<T, O>>
Returns void
Inherited from MLCharacterData.resetChildren
- Defined in @markuplint/ml-core/src/ml-dom/node/node.ts:814

substringData

substringData(offset: number, count: number): string
Parameters
- offset: number
- count: number
Returns string
Implementation of Comment.substringData

Inherited from MLCharacterData.substringData
- Defined in @markuplint/ml-core/src/ml-dom/node/character-data.ts:121

toString

toString(): string
Implements
@markuplint/ml-core API: MLDOMToken

Returns string
Inherited from MLCharacterData.toString
- Defined in @markuplint/ml-core/src/ml-dom/token/token.ts:96

Class Comment<T, O>

Type Parameters

T extends RuleConfigValue

O extends PlainData = undefined

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends RuleConfigValue

O extends PlainData = undefined

Parameters

astNode: MLASTComment

document: Document<T, O>

Returns Comment<T, O>

Properties

Private #childNodes

Private Readonly #endCol

Private Readonly #endLine

Private Readonly #endOffset

Private #fixed

Private Readonly #ownerDocument

Implements

See

Private #prevToken

Private Readonly #raw

Private Readonly #startCol

Private Readonly #startLine

Private Readonly #startOffset

Readonly ATTRIBUTE_NODE

Implements

See

Readonly CDATA_SECTION_NODE

Implements

See

Readonly COMMENT_NODE

Implements

See

Readonly DOCUMENT_FRAGMENT_NODE

Implements

See

Readonly DOCUMENT_NODE

Implements

See

Readonly DOCUMENT_POSITION_CONTAINED_BY

Implements

See

Readonly DOCUMENT_POSITION_CONTAINS

Implements

See

Readonly DOCUMENT_POSITION_DISCONNECTED

Implements

See

Readonly DOCUMENT_POSITION_FOLLOWING

Implements

See

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Implements

See

Readonly DOCUMENT_POSITION_PRECEDING

Implements

See

Readonly DOCUMENT_TYPE_NODE

Implements

See

Readonly ELEMENT_NODE

Implements

See

Readonly ENTITY_NODE

Deprecated

Implements

See

Readonly ENTITY_REFERENCE_NODE

Deprecated

Implements

`Private` #childNodes

`Private` `Readonly` #endCol

`Private` `Readonly` #endLine

`Private` `Readonly` #endOffset

`Private` #fixed

`Private` `Readonly` #ownerDocument

`Private` #prevToken

`Private` `Readonly` #raw

`Private` `Readonly` #startCol

`Private` `Readonly` #startLine

`Private` `Readonly` #startOffset

`Readonly` ATTRIBUTE_NODE

`Readonly` CDATA_SECTION_NODE

`Readonly` COMMENT_NODE

`Readonly` DOCUMENT_FRAGMENT_NODE

`Readonly` DOCUMENT_NODE

`Readonly` DOCUMENT_POSITION_CONTAINED_BY

`Readonly` DOCUMENT_POSITION_CONTAINS

`Readonly` DOCUMENT_POSITION_DISCONNECTED

`Readonly` DOCUMENT_POSITION_FOLLOWING

`Readonly` DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

`Readonly` DOCUMENT_POSITION_PRECEDING

`Readonly` DOCUMENT_TYPE_NODE

`Readonly` ELEMENT_NODE

`Readonly` ENTITY_NODE

`Readonly` ENTITY_REFERENCE_NODE

`Readonly` MARKUPLINT_PREPROCESSOR_BLOCK

`Readonly` NOTATION_NODE

`Readonly` PROCESSING_INSTRUCTION_NODE

`Readonly` TEXT_NODE

`Protected` _astToken

`Readonly` rules

`Readonly` uuid