ltxmlts
    Preparing search index...

    Class XContainer

    Abstract base class for XML nodes that can contain child nodes.

    XElement and XDocument extend XContainer. It provides the child-node collection, element and descendant queries, and content manipulation methods (add, remove, replace).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    nodeType parent

    Accessors

    document firstNode lastNode nextNode previousNode

    Methods

    add addAfterSelf addAnnotation addBeforeSelf addFirst ancestors annotation annotations deepEquals descendantNodes descendants element elements elementsAfterSelf elementsBeforeSelf equals insertAfterChild insertBeforeChild nodes nodesAfterSelf nodesBeforeSelf remove removeAnnotations removeChild removeNodes replaceChild replaceNodes replaceWith deepEquals

    Constructors

    Properties

    nodeType: XmlNodeType = null

    The kind of XML node this object represents.

    const el = new XElement('root');
    console.log(el.nodeType); // 'Element'
    parent: XObject | null = null

    The parent of this object in the XML tree, or null if it is a root.

    const child = new XElement('child');
    const parent = new XElement('parent', child);
    console.log(child.parent === parent); // true

    Accessors

    • get document(): XDocument | null

      Gets the XDocument that contains this object, or null if the object is not part of a document tree.

      Returns XDocument | null

      const doc = new XDocument(new XElement('root', new XElement('child')));
      const child = doc.root!.elements()[0];
      console.log(child.document === doc); // true
    • get nextNode(): XNode | null

      Gets the next sibling node, or null if this is the last node.

      Returns XNode | null

    • get previousNode(): XNode | null

      Gets the previous sibling node, or null if this is the first node.

      Returns XNode | null

    Methods

    • Appends content as children of this container.

      Parameters

      • ...content: unknown[]

        Nodes, strings, or arrays to add.

      Returns void

      Content rules:

      • XElement and other XNode subclasses are added as child nodes.
      • Strings are wrapped in XText.
      • Arrays are recursively unpacked.
      • XAttribute objects passed here are silently ignored; pass attributes to the XElement constructor or use XElement.setAttributeValue instead.
      • If a node already has a parent, it is cloned before being added.

    • Inserts the specified content immediately after this node in its parent.

      Parameters

      • ...content: unknown[]

        One or more nodes or strings to insert.

      Returns void

      Error if this node has no parent.

      const parent = new XElement('p', new XElement('a'), new XElement('c'));
      const a = parent.elements()[0];
      a.addAfterSelf(new XElement('b'));
      // parent now contains <a/>, <b/>, <c/>

    • Attaches an arbitrary annotation object to this XML object.

      Parameters

      • obj: unknown

        The annotation object to attach.

      Returns void

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));

    • Inserts the specified content immediately before this node in its parent.

      Parameters

      • ...content: unknown[]

        One or more nodes or strings to insert.

      Returns void

      Error if this node has no parent.

    • Inserts content as the first children of this container.

      Parameters

      • ...content: unknown[]

        Nodes, strings, or arrays to prepend.

      Returns void

    • Returns a collection of the ancestor elements of this node.

      Returns XElement[]

      An array of ancestor XElement instances.

      When called with no arguments, returns all ancestor elements from the immediate parent up to the root. When a name is supplied, only ancestors with that name are returned. The collection is ordered from nearest ancestor to farthest.

      const xml = XElement.parse('<root><a><b/></a></root>');
      const b = xml.descendants('b')[0];
      b.ancestors();        // [<a>, <root>]
      b.ancestors('root');  // [<root>]

    • Returns a collection of the ancestor elements of this node filtered by name.

      Parameters

      • name: string | XName

        Name to filter ancestors by.

      Returns XElement[]

    • Returns the first annotation of the specified type, or null if none exists.

      Type Parameters

      • T

        The annotation class to look up.

      Parameters

      • ctor: new (...args: any[]) => T

        Constructor of the annotation type to retrieve.

      Returns T | null

      The first matching annotation, or null.

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));
      const m = el.annotation(MyMeta);
      console.log(m?.tag); // 'important'

    • Returns all annotations of the specified type.

      Type Parameters

      • T

        The annotation class to look up.

      Parameters

      • ctor: new (...args: any[]) => T

        Constructor of the annotation type to retrieve.

      Returns T[]

      An array of matching annotations (may be empty).

    • Performs a deep structural comparison of this node with another.

      Parameters

      • other: XNode

        The node to compare against.

      Returns boolean

      true if the two nodes are structurally identical.

      Two nodes are deeply equal when they have the same node type and their content (including all descendants and attributes for elements) is equal.

      const e1 = XElement.parse('<a x="1"><b/></a>');
      const e2 = XElement.parse('<a x="1"><b/></a>');
      e1.deepEquals(e2); // true

    • Returns all descendant nodes of this container in document order.

      Returns XNode[]

      A flat array of all descendant XNode instances.

    • Returns the sibling elements that follow this node.

      Returns XElement[]

      An array of sibling XElement instances after this node.

      const parent = new XElement('p', new XElement('a'), new XElement('b'), new XElement('c'));
      const a = parent.elements()[0];
      a.elementsAfterSelf(); // [<b>, <c>]

    • Returns the sibling elements that follow this node, filtered by name.

      Parameters

      • name: string | XName

        Name to filter by.

      Returns XElement[]

    • Compares this container's child nodes with another container's for structural equality.

      Parameters

      • other: XContainer

        The container to compare against.

      Returns boolean

      true if both containers have the same child nodes in order.

    • Inserts content immediately after an existing child node.

      Parameters

      • child: XNode

        The reference child node.

      • ...content: unknown[]

        Content to insert after the child.

      Returns void

    • Inserts content immediately before an existing child node.

      Parameters

      • child: XNode

        The reference child node.

      • ...content: unknown[]

        Content to insert before the child.

      Returns void

    • Returns a shallow copy of this container's child nodes.

      Returns XNode[]

      A new array containing all direct child XNode instances.

    • Removes this node from its parent.

      Returns void

      Error if this node has no parent.

    • Removes annotations from this object.

      Returns void

      When called with no arguments, all annotations are removed. When called with a constructor, only annotations of that type are removed.

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));
      el.removeAnnotations(MyMeta);  // removes only MyMeta annotations
      el.removeAnnotations();        // removes everything

    • Removes annotations from this object.

      Type Parameters

      • T

      Parameters

      • ctor: new (...args: any[]) => T

      Returns void

      When called with no arguments, all annotations are removed. When called with a constructor, only annotations of that type are removed.

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));
      el.removeAnnotations(MyMeta);  // removes only MyMeta annotations
      el.removeAnnotations();        // removes everything

    • Removes a specific child node from this container.

      Parameters

      • child: XNode

        The child node to remove.

      Returns void

    • Removes all child nodes from this container.

      Returns void

    • Replaces an existing child node with the specified content.

      Parameters

      • child: XNode

        The child node to replace.

      • ...content: unknown[]

        Content that replaces the child.

      Returns void

    • Replaces all child nodes with the specified content.

      Parameters

      • ...content: unknown[]

        New content to use as children.

      Returns void

    • Replaces this node with the specified content.

      Parameters

      • ...content: unknown[]

        One or more nodes or strings that replace this node.

      Returns void

      Error if this node has no parent.

    • Static convenience method for deep structural comparison of two nodes.

      Parameters

      Returns boolean

      true if the two nodes are structurally identical.

      const e1 = XElement.parse('<a x="1"><b/></a>');
      const e2 = XElement.parse('<a x="1"><b/></a>');
      XNode.deepEquals(e1, e2); // true

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods