Blame view
node_modules/xmlcreate/lib/nodes/XmlProcInst.d.ts
3.41 KB
f7563de62
|
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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
/** * 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 processing instruction. * * An XML processing instruction is structured as follows, where `{target}` * and `{content}` are the target and content of the processing instruction * respectively. * * ```xml * <?{target} {content}?> * ``` * * The `{target}` and `{content}` values are properties of this node. * * XmlProcInst nodes cannot have any children. */ export default class XmlProcInst extends XmlNode { private _target; private _content?; /** * Initializes a new instance of the {@link XmlProcInst} class. * * @param target The target of the processing instruction. * @param content The data of the processing instruction, or undefined if * there is no target. */ constructor(target: string, content?: string); /** * Gets the target of the processing instruction. * * @returns The target of the processing instruction. */ /** * Sets the target of the processing instruction. * * @param target The target of the processing instruction. */ target: string; /** * Gets the data of the processing instruction. * * @returns The data of the processing instruction. This value may be * undefined. */ /** * Sets the data of the processing instruction. * * @param content The data of the processing instruction. This value may be * undefined. */ content: string | undefined; /** * Throws an exception since {@link XmlProcInst} nodes cannot have any * children. * * @returns This method does not return. */ children(): XmlNode[]; /** * Throws an exception since {@link XmlProcInst} 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 XmlProcInst} 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 XmlProcInst} 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; } |