XmlComment.d.ts
2.69 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/**
* Copyright (C) 2016 Michael Kourlas
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { IStringOptions } from "../options";
import XmlNode from "./XmlNode";
/**
* Represents an XML comment.
*
* An XML character reference is structured as follows, where `{content}` is
* the text of the comment.
*
* ```xml
* <!--{content}-->
* ```
*
* The `{content}` value is a property of this node.
*
* XmlComment nodes cannot have any children.
*/
export default class XmlComment extends XmlNode {
private _content;
/**
* Initializes a new instance of the {@link XmlComment} class.
*
* @param content The content of the comment.
*/
constructor(content: string);
/**
* Gets the content of the comment.
*
* @returns The content of the comment.
*/
/**
* Sets the content of the comment.
*
* @param content The content of the comment.
*/
content: string;
/**
* Throws an exception since {@link XmlComment} nodes cannot have any
* children.
*
* @returns This method does not return.
*/
children(): XmlNode[];
/**
* Throws an exception since {@link XmlComment} nodes cannot have any
* children.
*
* @param node This parameter is unused.
* @param index This parameter is unused.
*
* @returns This method does not return.
*/
insertChild(node: XmlNode, index?: number): XmlNode | undefined;
/**
* Throws an exception since {@link XmlComment} nodes cannot have any
* children.
*
* @param node This parameter is unused.
*
* @returns This method does not return.
*/
removeChild(node: XmlNode): boolean;
/**
* Throws an exception since {@link XmlComment} nodes cannot have any
* children.
*
* @param index This parameter is unused.
*
* @returns This method does not return.
*/
removeChildAtIndex(index: number): XmlNode;
/**
* Returns an XML string representation of this node.
*
* @param options Formatting options for the string representation.
*
* @returns An XML string representation of this node.
*/
toString(options?: IStringOptions): string;
}