XmlCharData.d.ts
2.3 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
import { IStringOptions } from "../options";
import XmlNode from "./XmlNode";
/**
* Represents character data in an XML document.
*
* Restricted characters, such as the ampersand (`&`), the opening angle
* bracket (`<`), and the closing angle bracket (`>`) when it appears in the
* string `]]>`, are all automatically escaped.
*
* To create an character reference or entity reference, you should use
* {@link XmlCharRef} or {@link XmlEntityRef} respectively instead.
*
* XmlCharData nodes cannot have any children.
*/
export default class XmlCharData extends XmlNode {
private _charData;
/**
* Initializes a new instance of the {@link XmlCharData} class.
*
* @param charData Character data.
*/
constructor(charData: string);
/**
* Gets the character data associated with this node.
*
* @returns The character data associated with this node.
*/
/**
* Sets the character data associated with this node.
*
* @param charData Character data.
*/
charData: string;
/**
* Throws an exception since {@link XmlCharData} nodes cannot have any
* children.
*
* @returns This method does not return.
*/
children(): XmlNode[];
/**
* Throws an exception since {@link XmlCharData} 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 XmlCharData} 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 XmlCharData} 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 {string} An XML string representation of this node.
*/
toString(options?: IStringOptions): string;
}