Class XAttribute

Represents an XML attribute on an element.

Remarks

Attributes are not nodes in the XNode sense -- they do not appear in nodes() or descendants() results -- but they inherit from XObject and carry the same parent reference and annotation API.

Example

const a = new XAttribute('id', '42');
a.name.localName; // 'id'
a.value; // '42'

Hierarchy (View Summary)

XObject
- XAttribute

Index

Constructors

constructor

new XAttribute(name: string | XName): XAttribute
Creates a new XAttribute with the given name and an empty-string value.
Parameters
- name: string | XName
  The qualified name of the attribute.
Returns XAttribute
Remarks
Accepts either a name and value, a name alone (empty-string value), or an existing XAttribute to copy.
Example
```
const a = new XAttribute('id', '42');
const copy = new XAttribute(a);
```
Overrides XObject.constructor
- Defined in src/XAttribute.ts:69
new XAttribute(name: string | XName, content: unknown): XAttribute
Creates a new XAttribute with the given name and value.
Parameters
- name: string | XName
  The qualified name of the attribute.
- content: unknown
  The value, converted to a string via toString().
Returns XAttribute
Overrides XObject.constructor
- Defined in src/XAttribute.ts:76
new XAttribute(other: XAttribute): XAttribute
Creates a new XAttribute by copying an existing one.
Parameters
- other: XAttribute
  The attribute to copy.
Returns XAttribute
Overrides XObject.constructor
- Defined in src/XAttribute.ts:82

Properties

`Readonly`name

name: XName

The fully-qualified name of this attribute.

nodeType

nodeType: XmlNodeType = null

The kind of XML node this object represents.

Example

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

parent

parent: XObject | null = null

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

Example

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

value

value: string

The string value of this attribute.

Accessors

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
```
Inherited from XDocument.document
- Defined in src/XObject.ts:173

isNamespaceDeclaration

get isNamespaceDeclaration(): boolean
Indicates whether this attribute is a namespace declaration (xmlns or xmlns:prefix).

Returns boolean
Example
```
new XAttribute(XNamespace.xmlns + 'w', 'http://...').isNamespaceDeclaration; // true
```
- Defined in src/XAttribute.ts:50

nextAttribute

get nextAttribute(): XAttribute | null
Returns the next sibling attribute on the parent element, or null.

Returns XAttribute | null
Example
```
const el = new XElement('a', new XAttribute('x','1'), new XAttribute('y','2'));
el.firstAttribute?.nextAttribute?.name.localName; // 'y'
```
- Defined in src/XAttribute.ts:180

previousAttribute

get previousAttribute(): XAttribute | null
Returns the previous sibling attribute on the parent element, or null.

Returns XAttribute | null
- Defined in src/XAttribute.ts:192

Methods

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'));
```
Inherited from XObject.addAnnotation
- Defined in src/XObject.ts:94

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'
```
Inherited from XObject.annotation
- Defined in src/XObject.ts:114

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).
Inherited from XObject.annotations
- Defined in src/XObject.ts:130

equals

equals(other: XAttribute): boolean
Compares this attribute to another by name and value.
Parameters
- other: XAttribute
  The attribute to compare against.
Returns boolean
true if both name and value are equal.
- Defined in src/XAttribute.ts:138

remove

remove(): void
Removes this attribute from its parent element.

Returns void
Throws
Error if the attribute has no parent.
- Defined in src/XAttribute.ts:111

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
```
Inherited from XObject.removeAnnotations
- Defined in src/XObject.ts:150
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
```
Inherited from XObject.removeAnnotations
- Defined in src/XObject.ts:151

setValue

setValue(value: string): void
Sets the value of this attribute.
Parameters
- value: string
  The new string value. Must not be null or undefined.
Returns void
Throws
Error if value is null or undefined.
- Defined in src/XAttribute.ts:125

toString

toString(): string
Returns the XML serialization of this attribute, e.g. name='value'.

Returns string
The serialized attribute string with XML-escaped value.
- Defined in src/XAttribute.ts:158

Class XAttribute

Remarks

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns XAttribute

Remarks

Example

Parameters

Returns XAttribute

Parameters

Returns XAttribute

Properties

Readonlyname

nodeType

Example

parent

Example

value

Accessors

document

Returns XDocument | null

Example

isNamespaceDeclaration

Returns boolean

Example

nextAttribute

Returns XAttribute | null

Example

previousAttribute

Returns XAttribute | null

Methods

addAnnotation

Parameters

Returns void

Example

annotation

Type Parameters

Parameters

Returns T | null

Example

annotations

Type Parameters

Parameters

Returns T[]

equals

Parameters

Returns boolean

remove

Returns void

Throws

removeAnnotations

Returns void

Remarks

Example

Type Parameters

Parameters

Returns void

Remarks

Example

setValue

Parameters

Returns void

Throws

toString

Returns string

Settings

On This Page

`Readonly`name