stax-xml

stax-xml

---

stax-xml

Declarative XML Converter Module

Remarks

This module provides a zod-style declarative API for parsing XML documents. It allows you to define XML schemas using a fluent API and parse XML with XPath support.

Example

Basic usage:

import { x } from 'stax-xml/converter';

const schema = x.object({
  title: x.string().xpath('/book/title'),
  author: x.string().xpath('/book/author'),
  price: x.number().xpath('/book/price')
});

const xml = '<book><title>TypeScript</title><author>John</author><price>29.99</price></book>';
const result = await schema.parse(xml);
// { title: 'TypeScript', author: 'John', price: 29.99 }

Classes

Writer

Defined in: Writer.ts:131

High-performance asynchronous XML writer implementing the StAX (Streaming API for XML) pattern.

This writer provides efficient streaming XML generation using WritableStream for handling large XML documents with automatic buffering, backpressure management, and namespace support.

This is an optimized implementation with:

• Optimization 1: Regex caching for entity escaping
• Optimization 2: Attribute string batching
• Optimization 3: Early entity check before regex execution
• Optimization 4: Qualified closing-tag stack (avoid rebuilding end tags)
• Optimization 5: Copy-on-write namespace frames
• Optimization 6: Indentation cache for pretty-print output
• Optimization 7: TextEncoder.encodeInto() buffering to reduce intermediate byte arrays
• Optimization 8: Flush by buffer view to avoid per-flush copy slices

Remarks

The writer supports streaming output with configurable buffering, automatic entity encoding, pretty printing with customizable indentation, and comprehensive namespace handling.

Examples

Basic usage:

const writableStream = new WritableStream({
  write(chunk) {
    console.log(new TextDecoder().decode(chunk));
  }
});

const writer = new Writer(writableStream);
await writer.writeStartElement('root');
await writer.writeElement('item', { id: '1' }, 'Hello World');
await writer.writeEndElement();
await writer.close();

With pretty printing:

const options = {
  prettyPrint: true,
  indentString: '    ',
  autoEncodeEntities: true
};
const writer = new Writer(writableStream, options);

Constructors

Constructor

new Writer(stream, options?): Writer

Defined in: Writer.ts:170

Parameters

stream

WritableStream<Uint8Array<ArrayBufferLike>>

options?

WriterOptions = {}

Returns

Writer

Methods

writeStartDocument()

writeStartDocument(version?, encoding?): Promise<Writer>

Defined in: Writer.ts:292

Write XML declaration

Parameters

version?

string = '1.0'

encoding?

string

Returns

Promise<Writer>

writeEndDocument()

writeEndDocument(): Promise<void>

Defined in: Writer.ts:317

End document (automatically close all elements)

Returns

Promise<void>

writeStartElement()

writeStartElement(localName, options?): Promise<Writer>

Defined in: Writer.ts:338

Write start element

Parameters

localName

string

options?

WriteElementOptions

Returns

Promise<Writer>

writeEndElement()

writeEndElement(): Promise<Writer>

Defined in: Writer.ts:430

Write end element

Returns

Promise<Writer>

writeCharacters()

writeCharacters(text): Promise<Writer>

Defined in: Writer.ts:463

Write text

Parameters

text

string

Returns

Promise<Writer>

writeCData()

writeCData(cdata): Promise<Writer>

Defined in: Writer.ts:485

Write CDATA section

Parameters

cdata

string

Returns

Promise<Writer>

writeComment()

writeComment(comment): Promise<Writer>

Defined in: Writer.ts:505

Write comment

Parameters

comment

string

Returns

Promise<Writer>

writeRaw()

writeRaw(xml): Promise<Writer>

Defined in: Writer.ts:528

Write raw XML content without escaping

Parameters

xml

string

Raw XML string to write

Returns

Promise<Writer>

this (chainable)

flush()

flush(): Promise<void>

Defined in: Writer.ts:537

Manual flush

Returns

Promise<void>

getMetrics()

getMetrics(): object

Defined in: Writer.ts:544

Return metrics

Returns

object

totalBytesWritten

totalBytesWritten: number = 0

flushCount

flushCount: number = 0

lastFlushTime

lastFlushTime: number = 0

bufferUtilization

bufferUtilization: number

averageFlushSize

averageFlushSize: number

---

WriterSync

Defined in: WriterSync.ts:493

String-based sync writer.

Extends

• AbstractWriterSync

Constructors

Constructor

new WriterSync(options?): WriterSync

Defined in: WriterSync.ts:496

Parameters

options?

WriterSyncOptions = {}

Returns

WriterSync

Overrides

AbstractWriterSync.constructor

Properties

state

protected state: number = WriterState.INITIAL

Defined in: WriterSync.ts:78

Inherited from

AbstractWriterSync.state

elementStack

protected elementStack: string[] = []

Defined in: WriterSync.ts:79

Inherited from

AbstractWriterSync.elementStack

hasTextContentStack

protected hasTextContentStack: boolean[] = []

Defined in: WriterSync.ts:80

Inherited from

AbstractWriterSync.hasTextContentStack

namespaceStack

protected namespaceStack: Map<string, string>[] = []

Defined in: WriterSync.ts:81

Inherited from

AbstractWriterSync.namespaceStack

namespaceOwnedStack

protected namespaceOwnedStack: boolean[] = []

Defined in: WriterSync.ts:82

Inherited from

AbstractWriterSync.namespaceOwnedStack

options

protected readonly options: Required<WriterSyncOptions>

Defined in: WriterSync.ts:83

Inherited from

AbstractWriterSync.options

currentIndentLevel

protected currentIndentLevel: number = 0

Defined in: WriterSync.ts:84

Inherited from

AbstractWriterSync.currentIndentLevel

needsIndent

protected needsIndent: boolean = false

Defined in: WriterSync.ts:85

Inherited from

AbstractWriterSync.needsIndent

indentCache

protected indentCache: string[]

Defined in: WriterSync.ts:86

Inherited from

AbstractWriterSync.indentCache

Methods

writeStartDocument()

writeStartDocument(version?, encoding?): this

Defined in: WriterSync.ts:133

Writes the XML declaration (e.g., ).

Parameters

version?

string = '1.0'

encoding?

string

Returns

this

Inherited from

AbstractWriterSync.writeStartDocument

writeEndDocument()

writeEndDocument(): void

Defined in: WriterSync.ts:158

Indicates the end of the document and automatically closes all open elements.

Returns

void

Inherited from

AbstractWriterSync.writeEndDocument

writeStartElement()

writeStartElement(localName, options?): this

Defined in: WriterSync.ts:170

Parameters

localName

string

options?

WriteElementOptions

Returns

this

Inherited from

AbstractWriterSync.writeStartElement

writeAttribute()

writeAttribute(localName, value, prefix?): this

Defined in: WriterSync.ts:249

Parameters

localName

string

value

string

prefix?

string

Returns

this

Inherited from

AbstractWriterSync.writeAttribute

writeNamespace()

writeNamespace(prefix, uri): this

Defined in: WriterSync.ts:259

Parameters

prefix

string

uri

string

Returns

this

Inherited from

AbstractWriterSync.writeNamespace

writeCharacters()

writeCharacters(text): this

Defined in: WriterSync.ts:276

Parameters

text

string

Returns

this

Inherited from

AbstractWriterSync.writeCharacters

writeCData()

writeCData(cdata): this

Defined in: WriterSync.ts:290

Parameters

cdata

string

Returns

this

Inherited from

AbstractWriterSync.writeCData

writeComment()

writeComment(comment): this

Defined in: WriterSync.ts:307

Parameters

comment

string

Returns

this

Inherited from

AbstractWriterSync.writeComment

writeProcessingInstruction()

writeProcessingInstruction(target, data?): this

Defined in: WriterSync.ts:322

Parameters

target

string

data?

string

Returns

this

Inherited from

AbstractWriterSync.writeProcessingInstruction

writeRaw()

writeRaw(xml): this

Defined in: WriterSync.ts:344

Parameters

xml

string

Returns

this

Inherited from

AbstractWriterSync.writeRaw

writeEndElement()

writeEndElement(): this

Defined in: WriterSync.ts:350

Returns

this

Inherited from

AbstractWriterSync.writeEndElement

setPrettyPrint()

setPrettyPrint(enabled): this

Defined in: WriterSync.ts:382

Parameters

enabled

boolean

Returns

this

Inherited from

AbstractWriterSync.setPrettyPrint

setIndentString()

setIndentString(indentString): this

Defined in: WriterSync.ts:387

Parameters

indentString

string

Returns

this

Inherited from

AbstractWriterSync.setIndentString

isPrettyPrintEnabled()

isPrettyPrintEnabled(): boolean

Defined in: WriterSync.ts:393

Returns

boolean

Inherited from

AbstractWriterSync.isPrettyPrintEnabled

getIndentString()

getIndentString(): string

Defined in: WriterSync.ts:397

Returns

string

Inherited from

AbstractWriterSync.getIndentString

_closeStartElementTag()

protected _closeStartElementTag(): void

Defined in: WriterSync.ts:419

Returns

void

Inherited from

AbstractWriterSync._closeStartElementTag

_writeNewline()

protected _writeNewline(): void

Defined in: WriterSync.ts:437

Returns

void

Inherited from

AbstractWriterSync._writeNewline

getXmlString()

getXmlString(): string

Defined in: WriterSync.ts:500

Returns

string

_emit()

protected _emit(chunk): void

Defined in: WriterSync.ts:504

Parameters

chunk

string

Returns

void

Overrides

AbstractWriterSync._emit

---

WriterSyncSink

Defined in: WriterSync.ts:512

Sink-based sync writer. Use this for file/buffer incremental writes.

Extends

• AbstractWriterSync

Constructors

Constructor

new WriterSyncSink(sink, options?): WriterSyncSink

Defined in: WriterSync.ts:520

Parameters

sink

SyncTextSink

options?

WriterSyncSinkOptions = {}

Returns

WriterSyncSink

Overrides

AbstractWriterSync.constructor

Properties

state

protected state: number = WriterState.INITIAL

Defined in: WriterSync.ts:78

Inherited from

AbstractWriterSync.state

elementStack

protected elementStack: string[] = []

Defined in: WriterSync.ts:79

Inherited from

AbstractWriterSync.elementStack

hasTextContentStack

protected hasTextContentStack: boolean[] = []

Defined in: WriterSync.ts:80

Inherited from

AbstractWriterSync.hasTextContentStack

namespaceStack

protected namespaceStack: Map<string, string>[] = []

Defined in: WriterSync.ts:81

Inherited from

AbstractWriterSync.namespaceStack

namespaceOwnedStack

protected namespaceOwnedStack: boolean[] = []

Defined in: WriterSync.ts:82

Inherited from

AbstractWriterSync.namespaceOwnedStack

options

protected readonly options: Required<WriterSyncOptions>

Defined in: WriterSync.ts:83

Inherited from

AbstractWriterSync.options

currentIndentLevel

protected currentIndentLevel: number = 0

Defined in: WriterSync.ts:84

Inherited from

AbstractWriterSync.currentIndentLevel

needsIndent

protected needsIndent: boolean = false

Defined in: WriterSync.ts:85

Inherited from

AbstractWriterSync.needsIndent

indentCache

protected indentCache: string[]

Defined in: WriterSync.ts:86

Inherited from

AbstractWriterSync.indentCache

Methods

writeStartDocument()

writeStartDocument(version?, encoding?): this

Defined in: WriterSync.ts:133

Writes the XML declaration (e.g., ).

Parameters

version?

string = '1.0'

encoding?

string

Returns

this

Inherited from

AbstractWriterSync.writeStartDocument

writeStartElement()

writeStartElement(localName, options?): this

Defined in: WriterSync.ts:170

Parameters

localName

string

options?

WriteElementOptions

Returns

this

Inherited from

AbstractWriterSync.writeStartElement

writeAttribute()

writeAttribute(localName, value, prefix?): this

Defined in: WriterSync.ts:249

Parameters

localName

string

value

string

prefix?

string

Returns

this

Inherited from

AbstractWriterSync.writeAttribute

writeNamespace()

writeNamespace(prefix, uri): this

Defined in: WriterSync.ts:259

Parameters

prefix

string

uri

string

Returns

this

Inherited from

AbstractWriterSync.writeNamespace

writeCharacters()

writeCharacters(text): this

Defined in: WriterSync.ts:276

Parameters

text

string

Returns

this

Inherited from

AbstractWriterSync.writeCharacters

writeCData()

writeCData(cdata): this

Defined in: WriterSync.ts:290

Parameters

cdata

string

Returns

this

Inherited from

AbstractWriterSync.writeCData

writeComment()

writeComment(comment): this

Defined in: WriterSync.ts:307

Parameters

comment

string

Returns

this

Inherited from

AbstractWriterSync.writeComment

writeProcessingInstruction()

writeProcessingInstruction(target, data?): this

Defined in: WriterSync.ts:322

Parameters

target

string

data?

string

Returns

this

Inherited from

AbstractWriterSync.writeProcessingInstruction

writeRaw()

writeRaw(xml): this

Defined in: WriterSync.ts:344

Parameters

xml

string

Returns

this

Inherited from

AbstractWriterSync.writeRaw

writeEndElement()

writeEndElement(): this

Defined in: WriterSync.ts:350

Returns

this

Inherited from

AbstractWriterSync.writeEndElement

setPrettyPrint()

setPrettyPrint(enabled): this

Defined in: WriterSync.ts:382

Parameters

enabled

boolean

Returns

this

Inherited from

AbstractWriterSync.setPrettyPrint

setIndentString()

setIndentString(indentString): this

Defined in: WriterSync.ts:387

Parameters

indentString

string

Returns

this

Inherited from

AbstractWriterSync.setIndentString

isPrettyPrintEnabled()

isPrettyPrintEnabled(): boolean

Defined in: WriterSync.ts:393

Returns

boolean

Inherited from

AbstractWriterSync.isPrettyPrintEnabled

getIndentString()

getIndentString(): string

Defined in: WriterSync.ts:397

Returns

string

Inherited from

AbstractWriterSync.getIndentString

_closeStartElementTag()

protected _closeStartElementTag(): void

Defined in: WriterSync.ts:419

Returns

void

Inherited from

AbstractWriterSync._closeStartElementTag

_writeNewline()

protected _writeNewline(): void

Defined in: WriterSync.ts:437

Returns

void

Inherited from

AbstractWriterSync._writeNewline

_emit()

protected _emit(chunk): void

Defined in: WriterSync.ts:536

Parameters

chunk

string

Returns

void

Overrides

AbstractWriterSync._emit

writeEndDocument()

writeEndDocument(): void

Defined in: WriterSync.ts:577

Indicates the end of the document and automatically closes all open elements.

Returns

void

Overrides

AbstractWriterSync.writeEndDocument

flush()

flush(): void

Defined in: WriterSync.ts:585

Returns

void

close()

close(): void

Defined in: WriterSync.ts:592

Returns

void

---

XmlArraySchema

Defined in: converter/XmlArraySchema.ts:16

Schema for parsing XML array values

Extends

• XmlSchemaBase<T["_output"][], T["_input"][]>

Type Parameters

T

T extends XmlSchemaBase<unknown, unknown>

Constructors

Constructor

new XmlArraySchema<T>(element, xpath?): XmlArraySchema<T>

Defined in: converter/XmlArraySchema.ts:19

Parameters

element

T

xpath?

string

Returns

XmlArraySchema<T>

Overrides

XmlSchemaBase.constructor

Properties

element

readonly element: T

Defined in: converter/XmlArraySchema.ts:20

xpath?

readonly optional xpath?: string

Defined in: converter/XmlArraySchema.ts:21

_output

readonly _output: T["_output"][]

Defined in: converter/base.ts:31

Inherited from

XmlSchemaBase._output

_input

readonly _input: T["_input"][]

Defined in: converter/base.ts:32

Inherited from

XmlSchemaBase._input

Methods

_parse()

_parse(input, parseOptions?): T["_output"][]

Defined in: converter/XmlArraySchema.ts:26

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

parseOptions?

ParseOptions

Returns

T["_output"][]

Parsed output

Throws

If parsing fails

Overrides

XmlSchemaBase._parse

_parseAsync()

_parseAsync(input, parseOptions?): Promise<T["_output"][]>

Defined in: converter/XmlArraySchema.ts:31

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

parseOptions?

ParseOptions

Returns

Promise<T["_output"][]>

Parsed output

Throws

If parsing fails

Overrides

XmlSchemaBase._parseAsync

parse()

parse(input, options?): Promise<T["_output"][]>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<T["_output"][]>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parse

parseSync()

parseSync(input, options?): T["_output"][]

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

T["_output"][]

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parseSync

safeParse()

safeParse(input, options?): Promise<ParseResult<T["_output"][]>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<T["_output"][]>>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParse

safeParseSync()

safeParseSync(input, options?): ParseResult<T["_output"][]>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<T["_output"][]>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParseSync

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, T["_input"][]>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, T["_input"][]>

New schema with transform applied

Inherited from

XmlSchemaBase.transform

optional()

optional(): XmlSchemaBase<T["_output"][] | undefined, T["_input"][] | undefined>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<T["_output"][] | undefined, T["_input"][] | undefined>

New optional schema

Inherited from

XmlSchemaBase.optional

array()

array(xpath?): XmlSchemaBase<T["_output"][][], T["_input"][][]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<T["_output"][][], T["_input"][][]>

New array schema

Inherited from

XmlSchemaBase.array

compile()

compile(): XmlSchemaBase<T["_output"][], T["_input"][]>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<T["_output"][], T["_input"][]>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

Inherited from

XmlSchemaBase.compile

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

T["_output"][]

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

Inherited from

XmlSchemaBase.write

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

T["_output"][]

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

Inherited from

XmlSchemaBase.writeToStream

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

T["_output"][]

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

Inherited from

XmlSchemaBase.writeSync

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

Inherited from

XmlSchemaBase.writer

---

XmlBuilder

Defined in: converter/XmlBuilder.ts:13

Builder API for creating XML schemas

Constructors

Constructor

new XmlBuilder(): XmlBuilder

Returns

XmlBuilder

Methods

string()

string(xpath?): XmlStringSchema

Defined in: converter/XmlBuilder.ts:19

Create a string schema

Parameters

xpath?

string

Optional XPath expression

Returns

XmlStringSchema

String schema

number()

number(xpath?): XmlNumberSchema

Defined in: converter/XmlBuilder.ts:28

Create a number schema

Parameters

xpath?

string

Optional XPath expression

Returns

XmlNumberSchema

Number schema

object()

object<T>(shape, options?): XmlObjectSchema<T>

Defined in: converter/XmlBuilder.ts:38

Create an object schema

Type Parameters

T

T extends XmlObjectShape

Parameters

shape

T

Object shape definition

options?

XmlObjectOptions

Optional object options

Returns

XmlObjectSchema<T>

Object schema

array()

array<T>(element, xpath?): XmlArraySchema<T>

Defined in: converter/XmlBuilder.ts:48

Create an array schema

Type Parameters

T

T extends XmlSchema<unknown, unknown>

Parameters

element

T

Element schema

xpath?

string

XPath expression for array elements

Returns

XmlArraySchema<T>

Array schema

---

XmlNumberSchema

Defined in: converter/XmlNumberSchema.ts:16

Schema for parsing XML number values

Extends

• XmlSchema<number, number>

Constructors

Constructor

new XmlNumberSchema(options?): XmlNumberSchema

Defined in: converter/XmlNumberSchema.ts:19

Parameters

options?

XmlNumberOptions = {}

Returns

XmlNumberSchema

Overrides

XmlSchema.constructor

Properties

options

options: XmlNumberOptions = {}

Defined in: converter/XmlNumberSchema.ts:19

_output

readonly _output: number

Defined in: converter/base.ts:31

Inherited from

XmlSchema._output

_input

readonly _input: number

Defined in: converter/base.ts:32

Inherited from

XmlSchema._input

Methods

_parse()

_parse(input, parseOptions?): number

Defined in: converter/XmlNumberSchema.ts:23

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

parseOptions?

ParseOptions

Returns

number

Parsed output

Throws

If parsing fails

Overrides

XmlSchema._parse

_parseAsync()

_parseAsync(input, parseOptions?): Promise<number>

Defined in: converter/XmlNumberSchema.ts:29

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

parseOptions?

ParseOptions

Returns

Promise<number>

Parsed output

Throws

If parsing fails

Overrides

XmlSchema._parseAsync

xpath()

xpath(path): XmlNumberSchema

Defined in: converter/XmlNumberSchema.ts:158

Set XPath expression for locating the element

Parameters

path

string

XPath expression

Returns

XmlNumberSchema

New schema with XPath

min()

min(value): XmlNumberSchema

Defined in: converter/XmlNumberSchema.ts:171

Set minimum value

Parameters

value

number

Minimum value

Returns

XmlNumberSchema

New schema with minimum

max()

max(value): XmlNumberSchema

Defined in: converter/XmlNumberSchema.ts:180

Set maximum value

Parameters

value

number

Maximum value

Returns

XmlNumberSchema

New schema with maximum

int()

int(): XmlNumberSchema

Defined in: converter/XmlNumberSchema.ts:188

Require integer value

Returns

XmlNumberSchema

New schema that only accepts integers

parse()

parse(input, options?): Promise<number>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<number>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchema.parse

parseSync()

parseSync(input, options?): number

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

number

Parsed output

Throws

If parsing fails

Inherited from

XmlSchema.parseSync

safeParse()

safeParse(input, options?): Promise<ParseResult<number>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<number>>

Parse result with success flag

Inherited from

XmlSchema.safeParse

safeParseSync()

safeParseSync(input, options?): ParseResult<number>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<number>

Parse result with success flag

Inherited from

XmlSchema.safeParseSync

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, number>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, number>

New schema with transform applied

Inherited from

XmlSchema.transform

optional()

optional(): XmlSchemaBase<number | undefined, number | undefined>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<number | undefined, number | undefined>

New optional schema

Inherited from

XmlSchema.optional

array()

array(xpath?): XmlSchemaBase<number[], number[]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<number[], number[]>

New array schema

Inherited from

XmlSchema.array

compile()

compile(): XmlSchemaBase<number, number>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<number, number>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

Inherited from

XmlSchema.compile

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

number

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

Inherited from

XmlSchema.write

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

number

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

Inherited from

XmlSchema.writeToStream

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

number

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

Inherited from

XmlSchema.writeSync

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

Inherited from

XmlSchema.writer

---

XmlObjectSchema

Defined in: converter/XmlObjectSchema.ts:58

Schema for parsing XML object values

Extends

• XmlSchema<InferObjectOutput<T>, unknown>

Type Parameters

T

T extends XmlObjectShape

Constructors

Constructor

new XmlObjectSchema<T>(shape, options?): XmlObjectSchema<T>

Defined in: converter/XmlObjectSchema.ts:61

Parameters

shape

T

options?

XmlObjectOptions = {}

Returns

XmlObjectSchema<T>

Overrides

XmlSchema.constructor

Properties

shape

readonly shape: T

Defined in: converter/XmlObjectSchema.ts:62

options

options: XmlObjectOptions = {}

Defined in: converter/XmlObjectSchema.ts:63

_output

readonly _output: Output

Defined in: converter/base.ts:31

Inherited from

XmlSchema._output

_input

readonly _input: unknown

Defined in: converter/base.ts:32

Inherited from

XmlSchema._input

Methods

_parse()

_parse(input, parseOptions?): InferObjectOutput<T>

Defined in: converter/XmlObjectSchema.ts:68

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

parseOptions?

ParseOptions

Returns

InferObjectOutput<T>

Parsed output

Throws

If parsing fails

Overrides

XmlSchema._parse

_parseAsync()

_parseAsync(input, parseOptions?): Promise<InferObjectOutput<T>>

Defined in: converter/XmlObjectSchema.ts:73

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

parseOptions?

ParseOptions

Returns

Promise<InferObjectOutput<T>>

Parsed output

Throws

If parsing fails

Overrides

XmlSchema._parseAsync

xpath()

xpath(path): XmlObjectSchema<T>

Defined in: converter/XmlObjectSchema.ts:126

Set XPath expression for locating the object

Parameters

path

string

XPath expression

Returns

XmlObjectSchema<T>

New schema with XPath

parse()

parse(input, options?): Promise<InferObjectOutput<T>>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<InferObjectOutput<T>>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchema.parse

parseSync()

parseSync(input, options?): Output

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

Output

Parsed output

Throws

If parsing fails

Inherited from

XmlSchema.parseSync

safeParse()

safeParse(input, options?): Promise<ParseResult<InferObjectOutput<T>>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<InferObjectOutput<T>>>

Parse result with success flag

Inherited from

XmlSchema.safeParse

safeParseSync()

safeParseSync(input, options?): ParseResult<InferObjectOutput<T>>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<InferObjectOutput<T>>

Parse result with success flag

Inherited from

XmlSchema.safeParseSync

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, unknown>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, unknown>

New schema with transform applied

Inherited from

XmlSchema.transform

optional()

optional(): XmlSchemaBase<InferObjectOutput<T> | undefined, unknown>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<InferObjectOutput<T> | undefined, unknown>

New optional schema

Inherited from

XmlSchema.optional

array()

array(xpath?): XmlSchemaBase<InferObjectOutput<T>[], unknown[]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<InferObjectOutput<T>[], unknown[]>

New array schema

Inherited from

XmlSchema.array

compile()

compile(): XmlSchemaBase<InferObjectOutput<T>, unknown>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<InferObjectOutput<T>, unknown>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

Inherited from

XmlSchema.compile

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

Inherited from

XmlSchema.write

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

Output

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

Inherited from

XmlSchema.writeToStream

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

Inherited from

XmlSchema.writeSync

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

Inherited from

XmlSchema.writer

---

XmlOptionalSchema

Defined in: converter/XmlOptionalSchema.ts:10

Schema for optional values

Extends

• XmlSchemaBase<T["_output"] | undefined, T["_input"] | undefined>

Type Parameters

T

T extends XmlSchemaBase<unknown, unknown>

Constructors

Constructor

new XmlOptionalSchema<T>(schema): XmlOptionalSchema<T>

Defined in: converter/XmlOptionalSchema.ts:13

Parameters

schema

T

Returns

XmlOptionalSchema<T>

Overrides

XmlSchemaBase.constructor

Properties

schema

readonly schema: T

Defined in: converter/XmlOptionalSchema.ts:13

_output

readonly _output: T["_output"] | undefined

Defined in: converter/base.ts:31

Inherited from

XmlSchemaBase._output

_input

readonly _input: T["_input"] | undefined

Defined in: converter/base.ts:32

Inherited from

XmlSchemaBase._input

Methods

_parse()

_parse(input, options?): T["_output"] | undefined

Defined in: converter/XmlOptionalSchema.ts:17

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

T["_output"] | undefined

Parsed output

Throws

If parsing fails

Overrides

XmlSchemaBase._parse

_parseAsync()

_parseAsync(input, options?): Promise<T["_output"] | undefined>

Defined in: converter/XmlOptionalSchema.ts:30

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<T["_output"] | undefined>

Parsed output

Throws

If parsing fails

Overrides

XmlSchemaBase._parseAsync

parse()

parse(input, options?): Promise<T["_output"] | undefined>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<T["_output"] | undefined>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parse

parseSync()

parseSync(input, options?): T["_output"] | undefined

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

T["_output"] | undefined

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parseSync

safeParse()

safeParse(input, options?): Promise<ParseResult<T["_output"] | undefined>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<T["_output"] | undefined>>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParse

safeParseSync()

safeParseSync(input, options?): ParseResult<T["_output"] | undefined>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<T["_output"] | undefined>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParseSync

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, T["_input"] | undefined>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, T["_input"] | undefined>

New schema with transform applied

Inherited from

XmlSchemaBase.transform

optional()

optional(): XmlSchemaBase<T["_output"] | undefined, T["_input"] | undefined>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<T["_output"] | undefined, T["_input"] | undefined>

New optional schema

Inherited from

XmlSchemaBase.optional

array()

array(xpath?): XmlSchemaBase<(T["_output"] | undefined)[], (T["_input"] | undefined)[]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<(T["_output"] | undefined)[], (T["_input"] | undefined)[]>

New array schema

Inherited from

XmlSchemaBase.array

compile()

compile(): XmlSchemaBase<T["_output"] | undefined, T["_input"] | undefined>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<T["_output"] | undefined, T["_input"] | undefined>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

Inherited from

XmlSchemaBase.compile

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

T["_output"] | undefined

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

Inherited from

XmlSchemaBase.write

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

T["_output"] | undefined

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

Inherited from

XmlSchemaBase.writeToStream

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

T["_output"] | undefined

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

Inherited from

XmlSchemaBase.writeSync

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

Inherited from

XmlSchemaBase.writer

---

abstract XmlSchema

Defined in: converter/XmlSchema.ts:10

Main XML schema class (extends XmlSchemaBase with all methods)

Extends

• XmlSchemaBase<Output, Input>

Extended by

• XmlStringSchema
• XmlNumberSchema
• XmlObjectSchema

Type Parameters

Output

Output

Input

Input = Output

Constructors

Constructor

new XmlSchema<Output, Input>(): XmlSchema<Output, Input>

Returns

XmlSchema<Output, Input>

Inherited from

XmlSchemaBase.constructor

Properties

_output

readonly _output: Output

Defined in: converter/base.ts:31

Inherited from

XmlSchemaBase._output

_input

readonly _input: Input

Defined in: converter/base.ts:32

Inherited from

XmlSchemaBase._input

Methods

_parse()

abstract _parse(input, options?): Output

Defined in: converter/base.ts:53

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

Output

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase._parse

_parseAsync()

abstract _parseAsync(input, options?): Promise<Output>

Defined in: converter/base.ts:62

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<Output>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase._parseAsync

parse()

parse(input, options?): Promise<Output>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<Output>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parse

parseSync()

parseSync(input, options?): Output

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

Output

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parseSync

safeParse()

safeParse(input, options?): Promise<ParseResult<Output>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<Output>>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParse

safeParseSync()

safeParseSync(input, options?): ParseResult<Output>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<Output>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParseSync

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, Input>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, Input>

New schema with transform applied

Inherited from

XmlSchemaBase.transform

optional()

optional(): XmlSchemaBase<Output | undefined, Input | undefined>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<Output | undefined, Input | undefined>

New optional schema

Inherited from

XmlSchemaBase.optional

array()

array(xpath?): XmlSchemaBase<Output[], Input[]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<Output[], Input[]>

New array schema

Inherited from

XmlSchemaBase.array

compile()

compile(): XmlSchemaBase<Output, Input>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<Output, Input>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

Inherited from

XmlSchemaBase.compile

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

Inherited from

XmlSchemaBase.write

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

Output

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

Inherited from

XmlSchemaBase.writeToStream

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

Inherited from

XmlSchemaBase.writeSync

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

Inherited from

XmlSchemaBase.writer

---

XmlStringSchema

Defined in: converter/XmlStringSchema.ts:27

Schema for parsing XML string values

Extends

• XmlSchema<string, string>

Constructors

Constructor

new XmlStringSchema(options?): XmlStringSchema

Defined in: converter/XmlStringSchema.ts:30

Parameters

options?

XmlStringOptions = {}

Returns

XmlStringSchema

Overrides

XmlSchema.constructor

Properties

options

options: XmlStringOptions = {}

Defined in: converter/XmlStringSchema.ts:30

_output

readonly _output: string

Defined in: converter/base.ts:31

Inherited from

XmlSchema._output

_input

readonly _input: string

Defined in: converter/base.ts:32

Inherited from

XmlSchema._input

Methods

_parse()

_parse(input, parseOptions?): string

Defined in: converter/XmlStringSchema.ts:34

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

parseOptions?

ParseOptions

Returns

string

Parsed output

Throws

If parsing fails

Overrides

XmlSchema._parse

_parseAsync()

_parseAsync(input, parseOptions?): Promise<string>

Defined in: converter/XmlStringSchema.ts:39

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

parseOptions?

ParseOptions

Returns

Promise<string>

Parsed output

Throws

If parsing fails

Overrides

XmlSchema._parseAsync

xpath()

xpath(path): XmlStringSchema

Defined in: converter/XmlStringSchema.ts:123

Set XPath expression for locating the element

Parameters

path

string

XPath expression

Returns

XmlStringSchema

New schema with XPath

parse()

parse(input, options?): Promise<string>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<string>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchema.parse

parseSync()

parseSync(input, options?): string

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

string

Parsed output

Throws

If parsing fails

Inherited from

XmlSchema.parseSync

safeParse()

safeParse(input, options?): Promise<ParseResult<string>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<string>>

Parse result with success flag

Inherited from

XmlSchema.safeParse

safeParseSync()

safeParseSync(input, options?): ParseResult<string>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<string>

Parse result with success flag

Inherited from

XmlSchema.safeParseSync

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, string>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, string>

New schema with transform applied

Inherited from

XmlSchema.transform

optional()

optional(): XmlSchemaBase<string | undefined, string | undefined>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<string | undefined, string | undefined>

New optional schema

Inherited from

XmlSchema.optional

array()

array(xpath?): XmlSchemaBase<string[], string[]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<string[], string[]>

New array schema

Inherited from

XmlSchema.array

compile()

compile(): XmlSchemaBase<string, string>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<string, string>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

Inherited from

XmlSchema.compile

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

string

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

Inherited from

XmlSchema.write

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

string

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

Inherited from

XmlSchema.writeToStream

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

string

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

Inherited from

XmlSchema.writeSync

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

Inherited from

XmlSchema.writer

---

XmlTransformSchema

Defined in: converter/XmlTransformSchema.ts:11

Schema for transforming parsed values

Extends

• XmlSchemaBase<Output, Input>

Type Parameters

Output

Output

Input

Input

IntermediateOutput

IntermediateOutput = unknown

Constructors

Constructor

new XmlTransformSchema<Output, Input, IntermediateOutput>(schema, transformFn): XmlTransformSchema<Output, Input, IntermediateOutput>

Defined in: converter/XmlTransformSchema.ts:19

Parameters

schema

XmlSchemaBase<IntermediateOutput, Input>

transformFn

(value) => Output

Returns

XmlTransformSchema<Output, Input, IntermediateOutput>

Overrides

XmlSchemaBase.constructor

Properties

_output

readonly _output: Output

Defined in: converter/base.ts:31

Inherited from

XmlSchemaBase._output

_input

readonly _input: Input

Defined in: converter/base.ts:32

Inherited from

XmlSchemaBase._input

Methods

_parse()

_parse(input, options?): Output

Defined in: converter/XmlTransformSchema.ts:28

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

Output

Parsed output

Throws

If parsing fails

Overrides

XmlSchemaBase._parse

_parseAsync()

_parseAsync(input, options?): Promise<Output>

Defined in: converter/XmlTransformSchema.ts:33

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<Output>

Parsed output

Throws

If parsing fails

Overrides

XmlSchemaBase._parseAsync

parse()

parse(input, options?): Promise<Output>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<Output>

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parse

parseSync()

parseSync(input, options?): Output

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

Output

Parsed output

Throws

If parsing fails

Inherited from

XmlSchemaBase.parseSync

safeParse()

safeParse(input, options?): Promise<ParseResult<Output>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<Output>>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParse

safeParseSync()

safeParseSync(input, options?): ParseResult<Output>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<Output>

Parse result with success flag

Inherited from

XmlSchemaBase.safeParseSync

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, Input>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, Input>

New schema with transform applied

Inherited from

XmlSchemaBase.transform

optional()

optional(): XmlSchemaBase<Output | undefined, Input | undefined>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<Output | undefined, Input | undefined>

New optional schema

Inherited from

XmlSchemaBase.optional

array()

array(xpath?): XmlSchemaBase<Output[], Input[]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<Output[], Input[]>

New array schema

Inherited from

XmlSchemaBase.array

compile()

compile(): XmlSchemaBase<Output, Input>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<Output, Input>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

Inherited from

XmlSchemaBase.compile

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

Inherited from

XmlSchemaBase.write

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

Output

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

Inherited from

XmlSchemaBase.writeToStream

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

Inherited from

XmlSchemaBase.writeSync

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

Inherited from

XmlSchemaBase.writer

---

abstract XmlSchemaBase

Defined in: converter/base.ts:30

Base abstract class for all XML schema types

Remarks

This class provides the foundation for zod-style declarative XML parsing. Each schema type extends this class and implements the parsing logic.

Extended by

• XmlSchema
• XmlArraySchema
• XmlOptionalSchema
• XmlTransformSchema

Type Parameters

Output

Output

Input

Input = Output

Constructors

Constructor

new XmlSchemaBase<Output, Input>(): XmlSchemaBase<Output, Input>

Returns

XmlSchemaBase<Output, Input>

Properties

_output

readonly _output: Output

Defined in: converter/base.ts:31

_input

readonly _input: Input

Defined in: converter/base.ts:32

Methods

_parse()

abstract _parse(input, options?): Output

Defined in: converter/base.ts:53

Parse XML input synchronously

Parameters

input

ParseInput

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

Output

Parsed output

Throws

If parsing fails

_parseAsync()

abstract _parseAsync(input, options?): Promise<Output>

Defined in: converter/base.ts:62

Parse XML input asynchronously

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<Output>

Parsed output

Throws

If parsing fails

parse()

parse(input, options?): Promise<Output>

Defined in: converter/base.ts:117

Parse XML asynchronously (public API)

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<Output>

Parsed output

Throws

If parsing fails

parseSync()

parseSync(input, options?): Output

Defined in: converter/base.ts:135

Parse XML synchronously (public API)

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string or sync iterator

options?

ParseOptions

Parse options

Returns

Output

Parsed output

Throws

If parsing fails

safeParse()

safeParse(input, options?): Promise<ParseResult<Output>>

Defined in: converter/base.ts:152

Parse XML asynchronously with error handling

Parameters

input

ParseInput

XML string, stream, or async iterator

options?

ParseOptions

Parse options

Returns

Promise<ParseResult<Output>>

Parse result with success flag

safeParseSync()

safeParseSync(input, options?): ParseResult<Output>

Defined in: converter/base.ts:173

Parse XML synchronously with error handling

Parameters

input

string | ArrayBufferView<ArrayBufferLike> | Iterator<AnyXmlEvent, any, any>

XML string, byte view, or sync iterator

options?

ParseOptions

Parse options

Returns

ParseResult<Output>

Parse result with success flag

transform()

transform<NewOutput>(fn): XmlSchemaBase<NewOutput, Input>

Defined in: converter/base.ts:193

Transform the parsed output

Type Parameters

NewOutput

NewOutput

Parameters

fn

(value) => NewOutput

Transform function

Returns

XmlSchemaBase<NewOutput, Input>

New schema with transform applied

optional()

optional(): XmlSchemaBase<Output | undefined, Input | undefined>

Defined in: converter/base.ts:201

Make this schema optional

Returns

XmlSchemaBase<Output | undefined, Input | undefined>

New optional schema

array()

array(xpath?): XmlSchemaBase<Output[], Input[]>

Defined in: converter/base.ts:210

Convert this schema to an array schema

Parameters

xpath?

string

XPath expression for array elements

Returns

XmlSchemaBase<Output[], Input[]>

New array schema

compile()

compile(): XmlSchemaBase<Output, Input>

Defined in: converter/base.ts:238

Compile this schema for repeated parsing.

Returns

XmlSchemaBase<Output, Input>

New compiled schema

Remarks

compile() preserves the public parsing API and can speed up schemas that can be lowered to fixed XML event dispatch. The optimized path works best when the root schema is an object, array, string, or number with static XPath selectors.

Fast-path friendly selectors use absolute paths such as /catalog/book, descendant paths such as //book, and relative selectors inside object or array items such as ./title, ./@id, ./name/text(), or ./name/@code. Object fields, arrays of scalar values, arrays of objects, nested objects, optional fields, and transforms are supported.

Selectors with wildcards or predicates, ambiguous relative paths such as title, nested arrays, and arrays that combine an array XPath with an element XPath are parsed with the normal runtime converter path instead. This keeps behavior compatible, but does not get the dispatch fast path.

Call compile() once on the root schema and reuse the returned schema. Non-object root schemas need an XPath.

write()

write(data, options?): Promise<string>

Defined in: converter/base.ts:249

Write data to XML string asynchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

Promise<string>

XML string

writeToStream()

writeToStream(data, stream, options?): Promise<void>

Defined in: converter/base.ts:272

Write data to WritableStream asynchronously (public API)

Parameters

data

Output

Data to write

stream

WritableStream<Uint8Array<ArrayBufferLike>>

Writable stream to write to

options?

XmlWriteOptions

Write options

Returns

Promise<void>

writeSync()

writeSync(data, options?): string

Defined in: converter/base.ts:286

Write data to XML string synchronously (public API)

Parameters

data

Output

Data to write

options?

XmlWriteOptions

Write options

Returns

string

XML string

writer()

writer(config): this

Defined in: converter/base.ts:295

Configure writer settings for this schema

Parameters

config

XmlElementWriteConfig

Writer configuration

Returns

this

This schema with writer config

---

XmlParseError

Defined in: converter/errors.ts:6

XML parse error with detailed issue information

Extends

• Error

Constructors

Constructor

new XmlParseError(issues): XmlParseError

Defined in: converter/errors.ts:16

Parameters

issues

object[]

Returns

XmlParseError

Overrides

Error.constructor

Properties

issues

issues: object[]

Defined in: converter/errors.ts:10

List of validation issues

path

path: string[]

message

message: string

code

code: string

Interfaces

WriterOptions

Defined in: Writer.ts:20

Configuration options for the Writer

Properties

encoding?

optional encoding?: string

Defined in: Writer.ts:25

Text encoding for the output stream

Default Value

'utf-8'

prettyPrint?

optional prettyPrint?: boolean

Defined in: Writer.ts:31

Whether to format output with indentation

Default Value

false

indentString?

optional indentString?: string

Defined in: Writer.ts:37

String used for indentation when prettyPrint is true

Default Value

'  '

addEntities?

optional addEntities?: object[]

Defined in: Writer.ts:43

Additional custom entities to encode

entity

entity: string

value

value: string

Default Value

[]

autoEncodeEntities?

optional autoEncodeEntities?: boolean

Defined in: Writer.ts:49

Whether to automatically encode XML entities

Default Value

true

namespaces?

optional namespaces?: NamespaceDeclaration[]

Defined in: Writer.ts:55

Namespace declarations to include

Default Value

[]

bufferSize?

optional bufferSize?: number

Defined in: Writer.ts:61

Internal buffer size in bytes

Default Value

16384

highWaterMark?

optional highWaterMark?: number

Defined in: Writer.ts:67

WritableStream backpressure threshold

Default Value

65536

flushThreshold?

optional flushThreshold?: number

Defined in: Writer.ts:73

Automatic flush threshold (percentage of bufferSize)

Default Value

0.8

enableAutoFlush?

optional enableAutoFlush?: boolean

Defined in: Writer.ts:79

Whether to enable automatic flushing

Default Value

true

---

SyncTextSink

Defined in: WriterSync.ts:7

Sink interface for custom sync targets.

Methods

write()

write(chunk): void

Defined in: WriterSync.ts:8

Parameters

chunk

string

Returns

void

flush()?

optional flush(): void

Defined in: WriterSync.ts:9

Returns

void

close()?

optional close(): void

Defined in: WriterSync.ts:10

Returns

void

---

WriterSyncOptions

Defined in: WriterSync.ts:16

Writer output options shared by string and sink variants.

Extended by

• WriterSyncSinkOptions

Properties

encoding?

optional encoding?: string

Defined in: WriterSync.ts:17

prettyPrint?

optional prettyPrint?: boolean

Defined in: WriterSync.ts:18

indentString?

optional indentString?: string

Defined in: WriterSync.ts:19

addEntities?

optional addEntities?: object[]

Defined in: WriterSync.ts:20

entity

entity: string

value

value: string

autoEncodeEntities?

optional autoEncodeEntities?: boolean

Defined in: WriterSync.ts:21

namespaces?

optional namespaces?: NamespaceDeclaration[]

Defined in: WriterSync.ts:22

---

WriterSyncSinkOptions

Defined in: WriterSync.ts:28

Writer options for sink-based sync mode.

Extends

• WriterSyncOptions

Properties

encoding?

optional encoding?: string

Defined in: WriterSync.ts:17

Inherited from

WriterSyncOptions.encoding

prettyPrint?

optional prettyPrint?: boolean

Defined in: WriterSync.ts:18

Inherited from

WriterSyncOptions.prettyPrint

indentString?

optional indentString?: string

Defined in: WriterSync.ts:19

Inherited from

WriterSyncOptions.indentString

addEntities?

optional addEntities?: object[]

Defined in: WriterSync.ts:20

entity

entity: string

value

value: string

Inherited from

WriterSyncOptions.addEntities

autoEncodeEntities?

optional autoEncodeEntities?: boolean

Defined in: WriterSync.ts:21

Inherited from

WriterSyncOptions.autoEncodeEntities

namespaces?

optional namespaces?: NamespaceDeclaration[]

Defined in: WriterSync.ts:22

Inherited from

WriterSyncOptions.namespaces

bufferSize?

optional bufferSize?: number

Defined in: WriterSync.ts:33

Internal character buffer size.

Default Value

16384

enableAutoFlush?

optional enableAutoFlush?: boolean

Defined in: WriterSync.ts:39

Emit buffered chunks automatically when threshold is reached.

Default Value

true

flushOnClose?

optional flushOnClose?: boolean

Defined in: WriterSync.ts:45

Whether to call sink.flush() when the writer is finalized.

Default Value

false

flushThreshold?

optional flushThreshold?: number

Defined in: WriterSync.ts:52

Flush threshold (percentage or absolute char count). If <= 1, treated as percentage of bufferSize. Otherwise absolute char count.

Default Value

0.8

---

ParseOptions

Defined in: converter/types.ts:10

Parse options for XML converter

Properties

trimText?

optional trimText?: boolean

Defined in: converter/types.ts:15

Whether to trim whitespace from text content

Default Value

false

decodeEntities?

optional decodeEntities?: boolean

Defined in: converter/types.ts:21

Whether to decode XML entities

Default Value

true

strict?

optional strict?: boolean

Defined in: converter/types.ts:27

Strict mode for parsing

Default Value

false

documentMode?

optional documentMode?: DocumentMode

Defined in: converter/types.ts:34

XML document conformance mode.

Default Value

'fragment'

maxDepth?

optional maxDepth?: number

Defined in: converter/types.ts:40

Maximum XML depth

Default Value

1000

maxEvents?

optional maxEvents?: number

Defined in: converter/types.ts:46

Maximum number of events to process

Default Value

1000000

xpathNamespaces?

optional xpathNamespaces?: Record<string, string>

Defined in: converter/types.ts:56

Namespace bindings used by XPath 1.0 prefix resolution.

Remarks

XML default namespaces do not automatically apply to unprefixed XPath element names, matching XPath 1.0 semantics. Bind a prefix here and use it in XPath expressions when selecting namespaced elements.

---

XmlStringOptions

Defined in: converter/types.ts:65

Options for string schema

Properties

xpath?

optional xpath?: string

Defined in: converter/types.ts:69

XPath expression to locate the element

min?

optional min?: number

Defined in: converter/types.ts:74

Minimum string length

max?

optional max?: number

Defined in: converter/types.ts:79

Maximum string length

pattern?

optional pattern?: RegExp

Defined in: converter/types.ts:84

Regular expression pattern to validate against

---

XmlNumberOptions

Defined in: converter/types.ts:92

Options for number schema

Properties

xpath?

optional xpath?: string

Defined in: converter/types.ts:96

XPath expression to locate the element

min?

optional min?: number

Defined in: converter/types.ts:101

Minimum value

max?

optional max?: number

Defined in: converter/types.ts:106

Maximum value

int?

optional int?: boolean

Defined in: converter/types.ts:112

Whether the number must be an integer

Default Value

false

---

XmlObjectOptions

Defined in: converter/types.ts:120

Options for object schema

Properties

xpath?

optional xpath?: string

Defined in: converter/types.ts:124

XPath expression to locate the element

strict?

optional strict?: boolean

Defined in: converter/types.ts:130

Strict mode - reject unknown properties

Default Value

false

---

XmlElementWriteConfig

Defined in: converter/types.ts:138

Writer configuration for XML element

Properties

element

element: string

Defined in: converter/types.ts:142

Element name (required)

asAttribute?

optional asAttribute?: string

Defined in: converter/types.ts:148

Write as attribute instead of element Value is the attribute name

namespace?

optional namespace?: object

Defined in: converter/types.ts:153

Namespace configuration

prefix?

optional prefix?: string

Namespace prefix (e.g., ‘dc’, ‘xsi’)

uri?

optional uri?: string

Namespace URI (e.g., ‘http://purl.org/dc/elements/1.1/‘)

cdata?

optional cdata?: boolean

Defined in: converter/types.ts:169

Wrap content in CDATA section

Default Value

false

selfClosing?

optional selfClosing?: boolean

Defined in: converter/types.ts:175

Use self-closing tag for empty elements

Default Value

false

comment?

optional comment?: string

Defined in: converter/types.ts:180

Add XML comment before element

---

XmlWriteOptions

Defined in: converter/types.ts:188

Options for XML writer

Properties

prettyPrint?

optional prettyPrint?: boolean

Defined in: converter/types.ts:193

Format output with indentation

Default Value

false

indentString?

optional indentString?: string

Defined in: converter/types.ts:199

Indentation string

Default Value

'  '

encoding?

optional encoding?: string

Defined in: converter/types.ts:205

Text encoding for output

Default Value

'utf-8'

rootElement?

optional rootElement?: string

Defined in: converter/types.ts:211

Root element name If not provided, no root element wrapper is added

namespaces?

optional namespaces?: object[]

Defined in: converter/types.ts:216

Global namespace declarations

prefix

prefix: string

uri

uri: string

includeDeclaration?

optional includeDeclaration?: boolean

Defined in: converter/types.ts:225

Include XML declaration

Default Value

true

xmlVersion?

optional xmlVersion?: string

Defined in: converter/types.ts:231

XML version for declaration

Default Value

'1.0'

writer?

optional writer?: Writer | WriterSync | WriterSyncSink

Defined in: converter/types.ts:239

Custom writer instance

• WriterSync: for writeSync() method
• WriterSyncSink: for writeSync() with custom sink
• Writer: for write() async method

---

StartDocumentEvent

Defined in: types.ts:48

Event fired when the document starts parsing

Properties

type

type: "START_DOCUMENT"

Defined in: types.ts:49

---

EndDocumentEvent

Defined in: types.ts:57

Event fired when the document ends parsing

Properties

type

type: "END_DOCUMENT"

Defined in: types.ts:58

---

StartElementEvent

Defined in: types.ts:66

Event fired when an XML element starts

Properties

type

type: "START_ELEMENT"

Defined in: types.ts:67

name

name: string

Defined in: types.ts:68

localName?

optional localName?: string

Defined in: types.ts:69

prefix?

optional prefix?: string

Defined in: types.ts:70

uri?

optional uri?: string

Defined in: types.ts:71

attributes

attributes: Record<string, string>

Defined in: types.ts:72

attributesWithPrefix?

optional attributesWithPrefix?: Record<string, AttributeInfo>

Defined in: types.ts:73

---

EndElementEvent

Defined in: types.ts:76

Properties

type

type: "END_ELEMENT"

Defined in: types.ts:77

name

name: string

Defined in: types.ts:78

localName?

optional localName?: string

Defined in: types.ts:79

prefix?

optional prefix?: string

Defined in: types.ts:80

uri?

optional uri?: string

Defined in: types.ts:81

---

CharactersEvent

Defined in: types.ts:84

Properties

type

type: "CHARACTERS"

Defined in: types.ts:85

value

value: string

Defined in: types.ts:86

---

CdataEvent

Defined in: types.ts:89

Properties

type

type: "CDATA"

Defined in: types.ts:90

value

value: string

Defined in: types.ts:91

---

ErrorEvent

Defined in: types.ts:94

Properties

type

type: "ERROR"

Defined in: types.ts:95

error

error: Error

Defined in: types.ts:96

---

XmlAttribute

Defined in: types.ts:114

Attribute interface (for Writer)

Properties

prefix?

optional prefix?: string

Defined in: types.ts:115

localName

localName: string

Defined in: types.ts:116

uri?

optional uri?: string

Defined in: types.ts:117

value

value: string

Defined in: types.ts:118

---

NamespaceDeclaration

Defined in: types.ts:125

Namespace declaration interface (for Writer) Not used in this simple implementation.

Properties

prefix

prefix: string

Defined in: types.ts:126

uri

uri: string

Defined in: types.ts:127

---

ProcessingInstruction

Defined in: types.ts:134

Processing instruction (PI) interface (for Writer) Not used in this simple implementation.

Properties

target

target: string

Defined in: types.ts:135

data?

optional data?: string

Defined in: types.ts:136

---

AttributeInfo

Defined in: types.ts:142

Attribute information interface

Properties

value

value: string

Defined in: types.ts:143

localName

localName: string

Defined in: types.ts:144

prefix?

optional prefix?: string

Defined in: types.ts:145

uri?

optional uri?: string

Defined in: types.ts:146

---

WriteElementOptions

Defined in: types.ts:354

Element writing options interface (for Writer)

Properties

prefix?

optional prefix?: string

Defined in: types.ts:355

uri?

optional uri?: string

Defined in: types.ts:356

attributes?

optional attributes?: Record<string, string | AttributeInfo>

Defined in: types.ts:357

selfClosing?

optional selfClosing?: boolean

Defined in: types.ts:358

comment?

optional comment?: string

Defined in: types.ts:359

Type Aliases

XmlObjectShape

XmlObjectShape = Record<string, XmlSchema<unknown, unknown>>

Defined in: converter/XmlObjectSchema.ts:42

Shape type for object schema

---

InferObjectOutput

InferObjectOutput<T> = { [K in keyof T]: T[K]["_output"] }

Defined in: converter/XmlObjectSchema.ts:49

Infer output type from object shape

Type Parameters

T

T extends XmlObjectShape

---

ParseInput

ParseInput = string | ArrayBufferView | ReadableStream<Uint8Array> | AsyncIterator<AnyXmlEvent> | Iterator<AnyXmlEvent>

Defined in: converter/base.ts:14

Parse input type - accepts string, sync iterator, async iterator, or ReadableStream

---

ParseResult

ParseResult<T> = { success: true; data: T; } | { success: false; error: XmlParseError; }

Defined in: converter/errors.ts:28

Parse result type for safe parsing operations

Type Parameters

T

T

---

Infer

Infer<T> = T["_output"]

Defined in: converter/index.ts:108

Type Parameters

T

T extends XmlSchema<unknown, unknown>

---

SchemaType

SchemaType = typeof SchemaType[keyof typeof SchemaType]

Defined in: converter/types.ts:247

Schema type union

---

XmlCoreSchema

XmlCoreSchema = XmlStringSchema | XmlNumberSchema | XmlArraySchema<XmlSchemaBase<unknown, unknown>> | XmlObjectSchema<XmlObjectShape>

Defined in: converter/types.ts:277

Core schema types (non-wrapper schemas)

---

XmlWrappedSchema

XmlWrappedSchema = XmlTransformSchema<unknown, unknown> | XmlOptionalSchema<XmlSchemaBase<unknown, unknown>>

Defined in: converter/types.ts:288

Wrapper schema types (transform and optional)

---

AnyXmlSchema

AnyXmlSchema = XmlCoreSchema | XmlWrappedSchema

Defined in: converter/types.ts:297

Any XML schema type

---

XmlEventType

XmlEventType = typeof XmlEventType[keyof typeof XmlEventType]

Defined in: types.ts:6

Enumeration of XML stream event types used by the StAX parser

---

AnyXmlEvent

AnyXmlEvent = StartDocumentEvent | EndDocumentEvent | StartElementEvent | EndElementEvent | CharactersEvent | CdataEvent | ErrorEvent

Defined in: types.ts:102

Discriminated Union type for developer use

---

DocumentMode

DocumentMode = "fragment" | "document"

Defined in: types.ts:373

XML document conformance mode.

Variables

x

const x: XmlBuilder

Defined in: converter/XmlBuilder.ts:58

Singleton builder instance

---

SchemaType

const SchemaType: object

Defined in: converter/types.ts:247

Schema type constants for XML schema classification

Type Declaration

STRING

readonly STRING: "STRING" = 'STRING'

NUMBER

readonly NUMBER: "NUMBER" = 'NUMBER'

ARRAY

readonly ARRAY: "ARRAY" = 'ARRAY'

OBJECT

readonly OBJECT: "OBJECT" = 'OBJECT'

TRANSFORM

readonly TRANSFORM: "TRANSFORM" = 'TRANSFORM'

OPTIONAL

readonly OPTIONAL: "OPTIONAL" = 'OPTIONAL'

---

XmlEventType

const XmlEventType: object

Defined in: types.ts:6

Enumeration of XML stream event types used by the StAX parser

Type Declaration

START_DOCUMENT

readonly START_DOCUMENT: "START_DOCUMENT" = 'START_DOCUMENT'

END_DOCUMENT

readonly END_DOCUMENT: "END_DOCUMENT" = 'END_DOCUMENT'

START_ELEMENT

readonly START_ELEMENT: "START_ELEMENT" = 'START_ELEMENT'

END_ELEMENT

readonly END_ELEMENT: "END_ELEMENT" = 'END_ELEMENT'

CHARACTERS

readonly CHARACTERS: "CHARACTERS" = 'CHARACTERS'

CDATA

readonly CDATA: "CDATA" = 'CDATA'

ERROR

readonly ERROR: "ERROR" = 'ERROR'

Functions

isStringSchema()

isStringSchema(schema): schema is XmlStringSchema

Defined in: converter/types.ts:304

Type guard for string schema

Parameters

schema

XmlSchemaBase<unknown, unknown>

Returns

schema is XmlStringSchema

---

isNumberSchema()

isNumberSchema(schema): schema is XmlNumberSchema

Defined in: converter/types.ts:313

Type guard for number schema

Parameters

schema

XmlSchemaBase<unknown, unknown>

Returns

schema is XmlNumberSchema

---

isArraySchema()

isArraySchema(schema): schema is XmlArraySchema<XmlSchemaBase<unknown, unknown>>

Defined in: converter/types.ts:322

Type guard for array schema

Parameters

schema

XmlSchemaBase<unknown, unknown>

Returns

schema is XmlArraySchema<XmlSchemaBase<unknown, unknown>>

---

isObjectSchema()

isObjectSchema(schema): schema is XmlObjectSchema<XmlObjectShape>

Defined in: converter/types.ts:331

Type guard for object schema

Parameters

schema

XmlSchemaBase<unknown, unknown>

Returns

schema is XmlObjectSchema<XmlObjectShape>

---

isTransformSchema()

isTransformSchema(schema): schema is XmlTransformSchema<unknown, unknown, unknown>

Defined in: converter/types.ts:340

Type guard for transform schema

Parameters

schema

XmlSchemaBase<unknown, unknown>

Returns

schema is XmlTransformSchema<unknown, unknown, unknown>

---

isOptionalSchema()

isOptionalSchema(schema): schema is XmlOptionalSchema<XmlSchemaBase<unknown, unknown>>

Defined in: converter/types.ts:349

Type guard for optional schema

Parameters

schema

XmlSchemaBase<unknown, unknown>

Returns

schema is XmlOptionalSchema<XmlSchemaBase<unknown, unknown>>