Class XObject

constructor

• new XObject(): XObject

  Returns XObject

nodeType

const el = new XElement('root');
console.log(el.nodeType); // 'Element'
Copy

parent

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

document

• 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

  Example

  const doc = new XDocument(new XElement('root', new XElement('child')));
  const child = doc.root!.elements()[0];
  console.log(child.document === doc); // true
  Copy

addAnnotation

• addAnnotation(obj: unknown): void

  Attaches an arbitrary annotation object to this XML object.

  Parameters

  • obj: unknown

    The annotation object to attach.

  Returns void

  Example

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

annotation

• annotation<T>(ctor: new (...args: any[]) => T): T | null

  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.

  Example

  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'
  Copy

annotations

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

  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).

removeAnnotations

• removeAnnotations(): void

  Removes annotations from this object.

  Returns void

  Remarks

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

  Example

  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
  Copy

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

  Removes annotations from this object.

  Type Parameters

  • T

  Parameters

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

  Returns void

  Remarks

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

  Example

  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
  Copy