@rgrove/parse-xml - v5.0.0
    Preparing search index...

    Class XmlDocumentType

    A document type declaration within an XML document.

    <!DOCTYPE kittens [
      <!ELEMENT kittens (#PCDATA)>
    ]>

    Hierarchy (View Summary)

    Index
    constructor
    end internalSubset name parent publicId start systemId TYPE_CDATA TYPE_COMMENT TYPE_DOCUMENT TYPE_DOCUMENT_TYPE TYPE_ELEMENT TYPE_PROCESSING_INSTRUCTION TYPE_TEXT TYPE_XML_DECLARATION
    document isRootNode preserveWhitespace type
    toJSON
    end: number = -1

    Ending byte offset of this node in the original XML string, or -1 if the offset is unknown.

    internalSubset: string | null

    Internal subset of this document type declaration, or null if no internal subset was present.

    name: string

    Name of the root element described by this document type declaration.

    parent: XmlDocument | XmlElement | null = null

    Parent node of this node, or null if this node has no parent.

    publicId: string | null

    Public identifier of the external subset of this document type declaration, or null if no public identifier was present.

    start: number = -1

    Starting byte offset of this node in the original XML string, or -1 if the offset is unknown.

    systemId: string | null

    System identifier of the external subset of this document type declaration, or null if no system identifier was present.

    TYPE_CDATA: "cdata" = 'cdata'

    Type value for an XmlCdata node.

    TYPE_COMMENT: "comment" = 'comment'

    Type value for an XmlComment node.

    TYPE_DOCUMENT: "document" = 'document'

    Type value for an XmlDocument node.

    TYPE_DOCUMENT_TYPE: "doctype" = 'doctype'

    Type value for an XmlDocumentType node.

    TYPE_ELEMENT: "element" = 'element'

    Type value for an XmlElement node.

    TYPE_PROCESSING_INSTRUCTION: "pi" = 'pi'

    Type value for an XmlProcessingInstruction node.

    Static ReadonlyTYPE_TEXT

    TYPE_TEXT: "text" = 'text'

    Type value for an XmlText node.

    TYPE_XML_DECLARATION: "xmldecl" = 'xmldecl'

    Type value for an XmlDeclaration node.

    • get document(): XmlDocument | null

      Document that contains this node, or null if this node is not associated with a document.

      Returns XmlDocument | null

    • get isRootNode(): boolean

      Whether this node is the root node of the document (also known as the document element).

      Returns boolean

    • get preserveWhitespace(): boolean

      Whether whitespace should be preserved in the content of this element and its children.

      This is influenced by the value of the special xml:space attribute, and will be true for any node whose xml:space attribute is set to "preserve". If a node has no such attribute, it will inherit the value of the nearest ancestor that does (if any).

      Returns boolean

      https://www.w3.org/TR/2008/REC-xml-20081126/#sec-white-space

    • get type(): string

      Type of this node.

      The value of this property is a string that matches one of the static TYPE_* properties on the XmlNode class (e.g. TYPE_ELEMENT, TYPE_TEXT, etc.).

      The XmlNode class itself is a base class and doesn't have its own type name.

      Returns string

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods