stax-xml

stax-xml

stax-xml

Classes

EventReader

Defined in: packages/stax-xml/src/EventReader.ts:30

Event-object adapter over the batch-first async stream core.

Implements

AsyncIterable<AnyXmlEvent>
AsyncIterator<AnyXmlEvent>

Constructors

Constructor

new EventReader(xmlStream, options?): EventReader

Defined in: packages/stax-xml/src/EventReader.ts:33

Parameters

xmlStream

ReadableStream<Uint8Array<ArrayBufferLike>>

options?

EventReaderOptions = {}

Returns

EventReader

Accessors

XmlEventType

Get Signature

get XmlEventType(): object

Defined in: packages/stax-xml/src/EventReader.ts:79

Returns

object

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'

Methods

[asyncIterator]()

[asyncIterator](): AsyncIterator<AnyXmlEvent>

Defined in: packages/stax-xml/src/EventReader.ts:54

Returns

AsyncIterator<AnyXmlEvent>

Implementation of

AsyncIterable.[asyncIterator]

next()

next(): Promise<IteratorResult<AnyXmlEvent, any>>

Defined in: packages/stax-xml/src/EventReader.ts:63

Returns

Promise<IteratorResult<AnyXmlEvent, any>>

Implementation of

AsyncIterator.next

return()

return(): Promise<IteratorResult<AnyXmlEvent, any>>

Defined in: packages/stax-xml/src/EventReader.ts:67

Returns

Promise<IteratorResult<AnyXmlEvent, any>>

Implementation of

AsyncIterator.return

nextBatch()

nextBatch(): Promise<AnyXmlEvent[] | null>

Defined in: packages/stax-xml/src/EventReader.ts:71

Returns

Promise<AnyXmlEvent[] | null>

batchedIterator()

batchedIterator(): AsyncGenerator<AnyXmlEvent[]>

Defined in: packages/stax-xml/src/EventReader.ts:75

Returns

AsyncGenerator<AnyXmlEvent[]>

EventReaderSync

Defined in: packages/stax-xml/src/EventReaderSync.ts:30

Event-object adapter over the batch-first sync stream core.

Implements

Iterable<AnyXmlEvent>
Iterator<AnyXmlEvent>

Constructors

Constructor

new EventReaderSync(xml, options?): EventReaderSync

Defined in: packages/stax-xml/src/EventReaderSync.ts:43

Parameters

xml

string

options?

EventReaderSyncOptions = {}

Returns

EventReaderSync

Methods

nextBatch()

nextBatch(): AnyXmlEvent[] | null

Defined in: packages/stax-xml/src/EventReaderSync.ts:75

Returns

AnyXmlEvent[] | null

batchedIterator()

batchedIterator(): IterableIterator<AnyXmlEvent[]>

Defined in: packages/stax-xml/src/EventReaderSync.ts:87

Returns

IterableIterator<AnyXmlEvent[]>

[iterator]()

[iterator](): Iterator<AnyXmlEvent>

Defined in: packages/stax-xml/src/EventReaderSync.ts:97

Returns

Iterator<AnyXmlEvent>

Implementation of

Iterable.[iterator]

next()

next(): IteratorResult<AnyXmlEvent>

Defined in: packages/stax-xml/src/EventReaderSync.ts:101

Returns

IteratorResult<AnyXmlEvent>

Implementation of

Iterator.next

return()

return(): IteratorResult<AnyXmlEvent>

Defined in: packages/stax-xml/src/EventReaderSync.ts:116

Returns

IteratorResult<AnyXmlEvent>

Implementation of

Iterator.return

StreamReader

Defined in: packages/stax-xml/src/StreamReader.ts:36

Batch-first asynchronous StAX core over ReadableStream<Uint8Array>.

Implements

AsyncIterable<StreamBatch>

Constructors

Constructor

new StreamReader(stream, options?): StreamReader

Defined in: packages/stax-xml/src/StreamReader.ts:45

Parameters

stream

ReadableStream<Uint8Array<ArrayBufferLike>>

options?

StreamReaderOptions = {}

Returns

StreamReader

Methods

nextBatch()

nextBatch(): Promise<StreamBatch | null>

Defined in: packages/stax-xml/src/StreamReader.ts:57

Returns

Promise<StreamBatch | null>

return()

return(): Promise<void>

Defined in: packages/stax-xml/src/StreamReader.ts:76

Returns

Promise<void>

batchedIterator()

batchedIterator(): AsyncGenerator<StreamBatch>

Defined in: packages/stax-xml/src/StreamReader.ts:89

Returns

AsyncGenerator<StreamBatch>

[asyncIterator]()

[asyncIterator](): AsyncGenerator<StreamBatch>

Defined in: packages/stax-xml/src/StreamReader.ts:105

Returns

AsyncGenerator<StreamBatch>

Implementation of

AsyncIterable.[asyncIterator]

currentGeneration()

currentGeneration(): number

Defined in: packages/stax-xml/src/StreamReader.ts:109

Returns

number

StreamReaderSync

Defined in: packages/stax-xml/src/StreamReaderSync.ts:41

Batch-first synchronous StAX core over bytes.

Implements

Iterable<StreamBatch>

Constructors

Constructor

new StreamReaderSync(source, options?): StreamReaderSync

Defined in: packages/stax-xml/src/StreamReaderSync.ts:46

Parameters

Constructor

new StreamReaderSync(source, options?): StreamReaderSync

Defined in: packages/stax-xml/src/StreamReaderSync.ts:47

Parameters

source

Uint8Array

options?

StreamReaderSyncOptions

Returns

StreamReaderSync

Methods

nextBatch()

nextBatch(): StreamBatch | null

Defined in: packages/stax-xml/src/StreamReaderSync.ts:59

Returns

StreamBatch | null

nextRawBatch()

nextRawBatch(): StreamReaderSyncRawBatch | null

Defined in: packages/stax-xml/src/StreamReaderSync.ts:81

Experimental

Return an experimental low-level batch view without creating per-event wrapper objects.

This API is intended for benchmark and scanner-style traversal paths. The existing nextBatch API remains the stable ergonomic surface.

Returns

StreamReaderSyncRawBatch | null

batchedIterator()

batchedIterator(): IterableIterator<StreamBatch>

Defined in: packages/stax-xml/src/StreamReaderSync.ts:113

Returns

IterableIterator<StreamBatch>

[iterator]()

[iterator](): IterableIterator<StreamBatch>

Defined in: packages/stax-xml/src/StreamReaderSync.ts:123

Returns

IterableIterator<StreamBatch>

Implementation of

Iterable.[iterator]

currentGeneration()

currentGeneration(): number

Defined in: packages/stax-xml/src/StreamReaderSync.ts:127

Returns

number

Writer

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/Writer.ts:170

Parameters

stream

WritableStream<Uint8Array<ArrayBufferLike>>

options?

WriterOptions = {}

Returns

Writer

Methods

writeStartDocument()

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

Defined in: packages/stax-xml/src/Writer.ts:292

Write XML declaration

Parameters

version?

string = '1.0'

encoding?

string

Returns

Promise<Writer>

writeEndDocument()

writeEndDocument(): Promise<void>

Defined in: packages/stax-xml/src/Writer.ts:317

End document (automatically close all elements)

Returns

Promise<void>

writeStartElement()

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

Defined in: packages/stax-xml/src/Writer.ts:338

Write start element

Parameters

localName

string

options?

WriteElementOptions

Returns

Promise<Writer>

writeEndElement()

writeEndElement(): Promise<Writer>

Defined in: packages/stax-xml/src/Writer.ts:430

Write end element

Returns

Promise<Writer>

writeCharacters()

writeCharacters(text): Promise<Writer>

Defined in: packages/stax-xml/src/Writer.ts:463

Write text

Parameters

text

string

Returns

Promise<Writer>

writeCData()

writeCData(cdata): Promise<Writer>

Defined in: packages/stax-xml/src/Writer.ts:485

Write CDATA section

Parameters

cdata

string

Returns

Promise<Writer>

writeComment()

writeComment(comment): Promise<Writer>

Defined in: packages/stax-xml/src/Writer.ts:505

Write comment

Parameters

comment

string

Returns

Promise<Writer>

writeRaw()

writeRaw(xml): Promise<Writer>

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/Writer.ts:537

Manual flush

Returns

Promise<void>

getMetrics()

getMetrics(): object

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/WriterSync.ts:493

String-based sync writer.

Extends

AbstractWriterSync

Constructors

Constructor

new WriterSync(options?): WriterSync

Defined in: packages/stax-xml/src/WriterSync.ts:496

Parameters

options?

WriterSyncOptions = {}

Returns

WriterSync

Overrides

AbstractWriterSync.constructor

Properties

state

protected state: number = WriterState.INITIAL

Defined in: packages/stax-xml/src/WriterSync.ts:78

Inherited from

AbstractWriterSync.state

elementStack

protected elementStack: string[] = []

Defined in: packages/stax-xml/src/WriterSync.ts:79

Inherited from

AbstractWriterSync.elementStack

hasTextContentStack

protected hasTextContentStack: boolean[] = []

Defined in: packages/stax-xml/src/WriterSync.ts:80

Inherited from

AbstractWriterSync.hasTextContentStack

namespaceStack

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

Defined in: packages/stax-xml/src/WriterSync.ts:81

Inherited from

AbstractWriterSync.namespaceStack

namespaceOwnedStack

protected namespaceOwnedStack: boolean[] = []

Defined in: packages/stax-xml/src/WriterSync.ts:82

Inherited from

AbstractWriterSync.namespaceOwnedStack

options

protected readonly options: Required<WriterSyncOptions>

Defined in: packages/stax-xml/src/WriterSync.ts:83

Inherited from

AbstractWriterSync.options

currentIndentLevel

protected currentIndentLevel: number = 0

Defined in: packages/stax-xml/src/WriterSync.ts:84

Inherited from

AbstractWriterSync.currentIndentLevel

needsIndent

protected needsIndent: boolean = false

Defined in: packages/stax-xml/src/WriterSync.ts:85

Inherited from

AbstractWriterSync.needsIndent

indentCache

protected indentCache: string[]

Defined in: packages/stax-xml/src/WriterSync.ts:86

Inherited from

AbstractWriterSync.indentCache

Methods

writeStartDocument()

writeStartDocument(version?, encoding?): this

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/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: packages/stax-xml/src/WriterSync.ts:170

Parameters

localName

string

options?

WriteElementOptions

Returns

this

Inherited from

AbstractWriterSync.writeStartElement

writeAttribute()

writeAttribute(localName, value, prefix?): this

Defined in: packages/stax-xml/src/WriterSync.ts:249

Parameters

localName

string

value

string

prefix?

string

Returns

this

Inherited from

AbstractWriterSync.writeAttribute

writeNamespace()

writeNamespace(prefix, uri): this

Defined in: packages/stax-xml/src/WriterSync.ts:259

Parameters

prefix

string

uri

string

Returns

this

Inherited from

AbstractWriterSync.writeNamespace

writeCharacters()

writeCharacters(text): this

Defined in: packages/stax-xml/src/WriterSync.ts:276

Parameters

text

string

Returns

this

Inherited from

AbstractWriterSync.writeCharacters

writeCData()

writeCData(cdata): this

Defined in: packages/stax-xml/src/WriterSync.ts:290

Parameters

cdata

string

Returns

this

Inherited from

AbstractWriterSync.writeCData

writeComment()

writeComment(comment): this

Defined in: packages/stax-xml/src/WriterSync.ts:307

Parameters

comment

string

Returns

this

Inherited from

AbstractWriterSync.writeComment

writeProcessingInstruction()

writeProcessingInstruction(target, data?): this

Defined in: packages/stax-xml/src/WriterSync.ts:322

Parameters

target

string

data?

string

Returns

this

Inherited from

AbstractWriterSync.writeProcessingInstruction

writeRaw()

writeRaw(xml): this

Defined in: packages/stax-xml/src/WriterSync.ts:344

Parameters

xml

string

Returns

this

Inherited from

AbstractWriterSync.writeRaw

writeEndElement()

writeEndElement(): this

Defined in: packages/stax-xml/src/WriterSync.ts:350

Returns

this

Inherited from

AbstractWriterSync.writeEndElement

setPrettyPrint()

setPrettyPrint(enabled): this

Defined in: packages/stax-xml/src/WriterSync.ts:382

Parameters

enabled

boolean

Returns

this

Inherited from

AbstractWriterSync.setPrettyPrint

setIndentString()

setIndentString(indentString): this

Defined in: packages/stax-xml/src/WriterSync.ts:387

Parameters

indentString

string

Returns

this

Inherited from

AbstractWriterSync.setIndentString

isPrettyPrintEnabled()

isPrettyPrintEnabled(): boolean

Defined in: packages/stax-xml/src/WriterSync.ts:393

Returns

boolean

Inherited from

AbstractWriterSync.isPrettyPrintEnabled

getIndentString()

getIndentString(): string

Defined in: packages/stax-xml/src/WriterSync.ts:397

Returns

string

Inherited from

AbstractWriterSync.getIndentString

_closeStartElementTag()

protected _closeStartElementTag(): void

Defined in: packages/stax-xml/src/WriterSync.ts:419

Returns

void

Inherited from

AbstractWriterSync._closeStartElementTag

_writeNewline()

protected _writeNewline(): void

Defined in: packages/stax-xml/src/WriterSync.ts:437

Returns

void

Inherited from

AbstractWriterSync._writeNewline

getXmlString()

getXmlString(): string

Defined in: packages/stax-xml/src/WriterSync.ts:500

Returns

string

_emit()

protected _emit(chunk): void

Defined in: packages/stax-xml/src/WriterSync.ts:504

Parameters

chunk

string

Returns

void

Overrides

AbstractWriterSync._emit

WriterSyncSink

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/WriterSync.ts:520

Parameters

sink

SyncTextSink

options?

WriterSyncSinkOptions = {}

Returns

WriterSyncSink

Overrides

AbstractWriterSync.constructor

Properties

state

protected state: number = WriterState.INITIAL

Defined in: packages/stax-xml/src/WriterSync.ts:78

Inherited from

AbstractWriterSync.state

elementStack

protected elementStack: string[] = []

Defined in: packages/stax-xml/src/WriterSync.ts:79

Inherited from

AbstractWriterSync.elementStack

hasTextContentStack

protected hasTextContentStack: boolean[] = []

Defined in: packages/stax-xml/src/WriterSync.ts:80

Inherited from

AbstractWriterSync.hasTextContentStack

namespaceStack

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

Defined in: packages/stax-xml/src/WriterSync.ts:81

Inherited from

AbstractWriterSync.namespaceStack

namespaceOwnedStack

protected namespaceOwnedStack: boolean[] = []

Defined in: packages/stax-xml/src/WriterSync.ts:82

Inherited from

AbstractWriterSync.namespaceOwnedStack

options

protected readonly options: Required<WriterSyncOptions>

Defined in: packages/stax-xml/src/WriterSync.ts:83

Inherited from

AbstractWriterSync.options

currentIndentLevel

protected currentIndentLevel: number = 0

Defined in: packages/stax-xml/src/WriterSync.ts:84

Inherited from

AbstractWriterSync.currentIndentLevel

needsIndent

protected needsIndent: boolean = false

Defined in: packages/stax-xml/src/WriterSync.ts:85

Inherited from

AbstractWriterSync.needsIndent

indentCache

protected indentCache: string[]

Defined in: packages/stax-xml/src/WriterSync.ts:86

Inherited from

AbstractWriterSync.indentCache

Methods

writeStartDocument()

writeStartDocument(version?, encoding?): this

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/WriterSync.ts:170

Parameters

localName

string

options?

WriteElementOptions

Returns

this

Inherited from

AbstractWriterSync.writeStartElement

writeAttribute()

writeAttribute(localName, value, prefix?): this

Defined in: packages/stax-xml/src/WriterSync.ts:249

Parameters

localName

string

value

string

prefix?

string

Returns

this

Inherited from

AbstractWriterSync.writeAttribute

writeNamespace()

writeNamespace(prefix, uri): this

Defined in: packages/stax-xml/src/WriterSync.ts:259

Parameters

prefix

string

uri

string

Returns

this

Inherited from

AbstractWriterSync.writeNamespace

writeCharacters()

writeCharacters(text): this

Defined in: packages/stax-xml/src/WriterSync.ts:276

Parameters

text

string

Returns

this

Inherited from

AbstractWriterSync.writeCharacters

writeCData()

writeCData(cdata): this

Defined in: packages/stax-xml/src/WriterSync.ts:290

Parameters

cdata

string

Returns

this

Inherited from

AbstractWriterSync.writeCData

writeComment()

writeComment(comment): this

Defined in: packages/stax-xml/src/WriterSync.ts:307

Parameters

comment

string

Returns

this

Inherited from

AbstractWriterSync.writeComment

writeProcessingInstruction()

writeProcessingInstruction(target, data?): this

Defined in: packages/stax-xml/src/WriterSync.ts:322

Parameters

target

string

data?

string

Returns

this

Inherited from

AbstractWriterSync.writeProcessingInstruction

writeRaw()

writeRaw(xml): this

Defined in: packages/stax-xml/src/WriterSync.ts:344

Parameters

xml

string

Returns

this

Inherited from

AbstractWriterSync.writeRaw

writeEndElement()

writeEndElement(): this

Defined in: packages/stax-xml/src/WriterSync.ts:350

Returns

this

Inherited from

AbstractWriterSync.writeEndElement

setPrettyPrint()

setPrettyPrint(enabled): this

Defined in: packages/stax-xml/src/WriterSync.ts:382

Parameters

enabled

boolean

Returns

this

Inherited from

AbstractWriterSync.setPrettyPrint

setIndentString()

setIndentString(indentString): this

Defined in: packages/stax-xml/src/WriterSync.ts:387

Parameters

indentString

string

Returns

this

Inherited from

AbstractWriterSync.setIndentString

isPrettyPrintEnabled()

isPrettyPrintEnabled(): boolean

Defined in: packages/stax-xml/src/WriterSync.ts:393

Returns

boolean

Inherited from

AbstractWriterSync.isPrettyPrintEnabled

getIndentString()

getIndentString(): string

Defined in: packages/stax-xml/src/WriterSync.ts:397

Returns

string

Inherited from

AbstractWriterSync.getIndentString

_closeStartElementTag()

protected _closeStartElementTag(): void

Defined in: packages/stax-xml/src/WriterSync.ts:419

Returns

void

Inherited from

AbstractWriterSync._closeStartElementTag

_writeNewline()

protected _writeNewline(): void

Defined in: packages/stax-xml/src/WriterSync.ts:437

Returns

void

Inherited from

AbstractWriterSync._writeNewline

_emit()

protected _emit(chunk): void

Defined in: packages/stax-xml/src/WriterSync.ts:536

Parameters

chunk

string

Returns

void

Overrides

AbstractWriterSync._emit

writeEndDocument()

writeEndDocument(): void

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/WriterSync.ts:585

Returns

void

close()

close(): void

Defined in: packages/stax-xml/src/WriterSync.ts:592

Returns

void

Interfaces

EventReaderOptions

Defined in: packages/stax-xml/src/EventReader.ts:16

Asynchronous event reader options.

Properties

autoDecodeEntities?

optional autoDecodeEntities?: boolean

Defined in: packages/stax-xml/src/EventReader.ts:17

addEntities?

optional addEntities?: EntityDefinition[]

Defined in: packages/stax-xml/src/EventReader.ts:18

eventFilter?

optional eventFilter?: ParserEventFilter

Defined in: packages/stax-xml/src/EventReader.ts:19

documentMode?

optional documentMode?: DocumentMode

Defined in: packages/stax-xml/src/EventReader.ts:20

namespaceAware?

optional namespaceAware?: boolean

Defined in: packages/stax-xml/src/EventReader.ts:21

maxChunkBytes?

optional maxChunkBytes?: number

Defined in: packages/stax-xml/src/EventReader.ts:22

EventReaderSyncOptions

Defined in: packages/stax-xml/src/EventReaderSync.ts:17

Synchronous event reader options.

Properties

autoDecodeEntities?

optional autoDecodeEntities?: boolean

Defined in: packages/stax-xml/src/EventReaderSync.ts:18

addEntities?

optional addEntities?: EntityDefinition[]

Defined in: packages/stax-xml/src/EventReaderSync.ts:19

eventFilter?

optional eventFilter?: ParserEventFilter

Defined in: packages/stax-xml/src/EventReaderSync.ts:20

documentMode?

optional documentMode?: DocumentMode

Defined in: packages/stax-xml/src/EventReaderSync.ts:21

namespaceAware?

optional namespaceAware?: boolean

Defined in: packages/stax-xml/src/EventReaderSync.ts:22

EntityDefinition

Defined in: packages/stax-xml/src/IterableEventBackend.ts:17

Properties

entity

entity: string

Defined in: packages/stax-xml/src/IterableEventBackend.ts:18

value

value: string

Defined in: packages/stax-xml/src/IterableEventBackend.ts:19

StreamReaderOptions

Defined in: packages/stax-xml/src/StreamReader.ts:15

Asynchronous stream reader options.

Properties

encoding?

optional encoding?: string

Defined in: packages/stax-xml/src/StreamReader.ts:21

Text encoding passed to the active streaming backend.

Default Value

'utf-8'

documentMode?

optional documentMode?: DocumentMode

Defined in: packages/stax-xml/src/StreamReader.ts:28

XML document conformance mode.

Default Value

'fragment'

StreamReaderSyncOptions

Defined in: packages/stax-xml/src/StreamReaderSync.ts:20

Synchronous stream reader options.

Properties

encoding?

optional encoding?: string

Defined in: packages/stax-xml/src/StreamReaderSync.ts:26

Text encoding passed to the active streaming backend.

Default Value

'utf-8'

documentMode?

optional documentMode?: DocumentMode

Defined in: packages/stax-xml/src/StreamReaderSync.ts:33

XML document conformance mode.

Default Value

'fragment'

WriterOptions

Defined in: packages/stax-xml/src/Writer.ts:20

Configuration options for the Writer

Properties

encoding?

optional encoding?: string

Defined in: packages/stax-xml/src/Writer.ts:25

Text encoding for the output stream

Default Value

'utf-8'

prettyPrint?

optional prettyPrint?: boolean

Defined in: packages/stax-xml/src/Writer.ts:31

Whether to format output with indentation

Default Value

false

indentString?

optional indentString?: string

Defined in: packages/stax-xml/src/Writer.ts:37

String used for indentation when prettyPrint is true

Default Value

'  '

addEntities?

optional addEntities?: object[]

Defined in: packages/stax-xml/src/Writer.ts:43

Additional custom entities to encode

entity

entity: string

value

value: string

Default Value

[]

autoEncodeEntities?

optional autoEncodeEntities?: boolean

Defined in: packages/stax-xml/src/Writer.ts:49

Whether to automatically encode XML entities

Default Value

true

namespaces?

optional namespaces?: NamespaceDeclaration[]

Defined in: packages/stax-xml/src/Writer.ts:55

Namespace declarations to include

Default Value

[]

bufferSize?

optional bufferSize?: number

Defined in: packages/stax-xml/src/Writer.ts:61

Internal buffer size in bytes

Default Value

highWaterMark?

optional highWaterMark?: number

Defined in: packages/stax-xml/src/Writer.ts:67

WritableStream backpressure threshold

Default Value

flushThreshold?

optional flushThreshold?: number

Defined in: packages/stax-xml/src/Writer.ts:73

Automatic flush threshold (percentage of bufferSize)

Default Value

0.8

enableAutoFlush?

optional enableAutoFlush?: boolean

Defined in: packages/stax-xml/src/Writer.ts:79

Whether to enable automatic flushing

Default Value

true

SyncTextSink

Defined in: packages/stax-xml/src/WriterSync.ts:7

Sink interface for custom sync targets.

Methods

write()

write(chunk): void

Defined in: packages/stax-xml/src/WriterSync.ts:8

Parameters

chunk

string

Returns

void

flush()?

optional flush(): void

Defined in: packages/stax-xml/src/WriterSync.ts:9

Returns

void

close()?

optional close(): void

Defined in: packages/stax-xml/src/WriterSync.ts:10

Returns

void

WriterSyncOptions

Defined in: packages/stax-xml/src/WriterSync.ts:16

Writer output options shared by string and sink variants.

Extended by

WriterSyncSinkOptions

Properties

encoding?

optional encoding?: string

Defined in: packages/stax-xml/src/WriterSync.ts:17

prettyPrint?

optional prettyPrint?: boolean

Defined in: packages/stax-xml/src/WriterSync.ts:18

indentString?

optional indentString?: string

Defined in: packages/stax-xml/src/WriterSync.ts:19

addEntities?

optional addEntities?: object[]

Defined in: packages/stax-xml/src/WriterSync.ts:20

entity

entity: string

value

value: string

autoEncodeEntities?

optional autoEncodeEntities?: boolean

Defined in: packages/stax-xml/src/WriterSync.ts:21

namespaces?

optional namespaces?: NamespaceDeclaration[]

Defined in: packages/stax-xml/src/WriterSync.ts:22

WriterSyncSinkOptions

Defined in: packages/stax-xml/src/WriterSync.ts:28

Writer options for sink-based sync mode.

Extends

WriterSyncOptions

Properties

encoding?

optional encoding?: string

Defined in: packages/stax-xml/src/WriterSync.ts:17

Inherited from

WriterSyncOptions.encoding

prettyPrint?

optional prettyPrint?: boolean

Defined in: packages/stax-xml/src/WriterSync.ts:18

Inherited from

WriterSyncOptions.prettyPrint

indentString?

optional indentString?: string

Defined in: packages/stax-xml/src/WriterSync.ts:19

Inherited from

WriterSyncOptions.indentString

addEntities?

optional addEntities?: object[]

Defined in: packages/stax-xml/src/WriterSync.ts:20

entity

entity: string

value

value: string

Inherited from

WriterSyncOptions.addEntities

autoEncodeEntities?

optional autoEncodeEntities?: boolean

Defined in: packages/stax-xml/src/WriterSync.ts:21

Inherited from

WriterSyncOptions.autoEncodeEntities

namespaces?

optional namespaces?: NamespaceDeclaration[]

Defined in: packages/stax-xml/src/WriterSync.ts:22

Inherited from

WriterSyncOptions.namespaces

bufferSize?

optional bufferSize?: number

Defined in: packages/stax-xml/src/WriterSync.ts:33

Internal character buffer size.

Default Value

enableAutoFlush?

optional enableAutoFlush?: boolean

Defined in: packages/stax-xml/src/WriterSync.ts:39

Emit buffered chunks automatically when threshold is reached.

Default Value

true

flushOnClose?

optional flushOnClose?: boolean

Defined in: packages/stax-xml/src/WriterSync.ts:45

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

Default Value

false

flushThreshold?

optional flushThreshold?: number

Defined in: packages/stax-xml/src/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

ParseXmlTreeOptions

Defined in: packages/stax-xml/src/XmlObject.ts:25

Options shared by XML tree and compact object helper parsers.

Extended by

ParseXmlObjectOptions

Properties

encoding?

optional encoding?: string

Defined in: packages/stax-xml/src/XmlObject.ts:26

documentMode?

optional documentMode?: DocumentMode

Defined in: packages/stax-xml/src/XmlObject.ts:27

autoDecodeEntities?

optional autoDecodeEntities?: boolean

Defined in: packages/stax-xml/src/XmlObject.ts:28

addEntities?

optional addEntities?: EntityDefinition[]

Defined in: packages/stax-xml/src/XmlObject.ts:29

trimText?

optional trimText?: boolean

Defined in: packages/stax-xml/src/XmlObject.ts:30

batchSize?

optional batchSize?: number

Defined in: packages/stax-xml/src/XmlObject.ts:31

ParseXmlObjectOptions

Defined in: packages/stax-xml/src/XmlObject.ts:35

Options for compact object projection.

Extends

ParseXmlTreeOptions

Properties

encoding?

optional encoding?: string

Defined in: packages/stax-xml/src/XmlObject.ts:26

Inherited from

ParseXmlTreeOptions.encoding

documentMode?

optional documentMode?: DocumentMode

Defined in: packages/stax-xml/src/XmlObject.ts:27

Inherited from

ParseXmlTreeOptions.documentMode

autoDecodeEntities?

optional autoDecodeEntities?: boolean

Defined in: packages/stax-xml/src/XmlObject.ts:28

Inherited from

ParseXmlTreeOptions.autoDecodeEntities

addEntities?

optional addEntities?: EntityDefinition[]

Defined in: packages/stax-xml/src/XmlObject.ts:29

Inherited from

ParseXmlTreeOptions.addEntities

trimText?

optional trimText?: boolean

Defined in: packages/stax-xml/src/XmlObject.ts:30

Inherited from

ParseXmlTreeOptions.trimText

batchSize?

optional batchSize?: number

Defined in: packages/stax-xml/src/XmlObject.ts:31

Inherited from

ParseXmlTreeOptions.batchSize

attributePrefix?

optional attributePrefix?: string

Defined in: packages/stax-xml/src/XmlObject.ts:37

Prefix applied to XML attributes. Defaults to @, so id becomes @id.

textKey?

optional textKey?: string

Defined in: packages/stax-xml/src/XmlObject.ts:39

Key used for text in mixed-content objects. Defaults to #text.

cdataKey?

optional cdataKey?: string

Defined in: packages/stax-xml/src/XmlObject.ts:41

Key used for CDATA in compact objects. Defaults to #cdata.

alwaysArray?

optional alwaysArray?: boolean

Defined in: packages/stax-xml/src/XmlObject.ts:43

When true, element children are always represented as arrays.

XmlTreeDocument

Defined in: packages/stax-xml/src/XmlObject.ts:47

Document wrapper returned by parseXmlTree() and parseXmlTreeSync().

Properties

type

type: "document"

Defined in: packages/stax-xml/src/XmlObject.ts:48

children

children: XmlTreeNode[]

Defined in: packages/stax-xml/src/XmlObject.ts:49

XmlTreeElement

Defined in: packages/stax-xml/src/XmlObject.ts:55

Order-preserving XML element node.

Properties

type

type: "element"

Defined in: packages/stax-xml/src/XmlObject.ts:56

name

name: string

Defined in: packages/stax-xml/src/XmlObject.ts:57

attributes

attributes: XmlObjectRecord<string>

Defined in: packages/stax-xml/src/XmlObject.ts:58

children

children: XmlTreeNode[]

Defined in: packages/stax-xml/src/XmlObject.ts:59

XmlTreeText

Defined in: packages/stax-xml/src/XmlObject.ts:63

Text node in an order-preserving XML tree.

Properties

type

type: "text"

Defined in: packages/stax-xml/src/XmlObject.ts:64

value

value: string

Defined in: packages/stax-xml/src/XmlObject.ts:65

XmlTreeCdata

Defined in: packages/stax-xml/src/XmlObject.ts:69

CDATA node in an order-preserving XML tree.

Properties

type

type: "cdata"

Defined in: packages/stax-xml/src/XmlObject.ts:70

value

value: string

Defined in: packages/stax-xml/src/XmlObject.ts:71

XmlObjectArray

Defined in: packages/stax-xml/src/XmlObject.ts:78

Array of compact object values used for repeated elements.

Extends

Array<XmlObjectValue>

Indexable

[n: number]: XmlObjectValue

XmlObjectRecord

Defined in: packages/stax-xml/src/XmlObject.ts:81

Null-prototype record used by tree attributes and compact object nodes.

Type Parameters

T

T = XmlObjectValue

Indexable

[key: string]: T

StreamEventView

Defined in: packages/stax-xml/src/stream-reader-core.ts:34

Batch-local event view.

Properties

type

readonly type: StreamEventType

Defined in: packages/stax-xml/src/stream-reader-core.ts:35

Methods

name()

name(): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:36

Returns

string | undefined

text()

text(): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:37

Returns

string | undefined

getAttributeCount()

getAttributeCount(): number

Defined in: packages/stax-xml/src/stream-reader-core.ts:38

Returns

number

getAttributeName()

getAttributeName(index): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:39

Parameters

index

number

Returns

string | undefined

getAttributeValue()

getAttributeValue(indexOrName): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:40

Parameters

indexOrName

string | number

Returns

string | undefined

StreamBatch

Defined in: packages/stax-xml/src/stream-reader-core.ts:48

Batch view exposed by stream readers.

Extends

Iterable<StreamEventView>

Properties

eventCount

readonly eventCount: number

Defined in: packages/stax-xml/src/stream-reader-core.ts:49

Methods

event()

event(index): StreamEventView

Defined in: packages/stax-xml/src/stream-reader-core.ts:50

Parameters

index

number

Returns

StreamEventView

typeAt()

typeAt(index): StreamEventType

Defined in: packages/stax-xml/src/stream-reader-core.ts:51

Parameters

index

number

Returns

StreamEventType

nameAt()

nameAt(index): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:52

Parameters

index

number

Returns

string | undefined

textAt()

textAt(index): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:53

Parameters

index

number

Returns

string | undefined

attributeCountAt()

attributeCountAt(index): number

Defined in: packages/stax-xml/src/stream-reader-core.ts:54

Parameters

index

number

Returns

number

attributeNameAt()

attributeNameAt(eventIndex, attrIndex): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:55

Parameters

eventIndex

number

attrIndex

number

Returns

string | undefined

attributeValueAt()

attributeValueAt(eventIndex, attrIndexOrName): string | undefined

Defined in: packages/stax-xml/src/stream-reader-core.ts:56

Parameters

eventIndex

number

attrIndexOrName

string | number

Returns

string | undefined

StartDocumentEvent

Defined in: packages/stax-xml/src/types.ts:48

Event fired when the document starts parsing

Properties

type

type: "START_DOCUMENT"

Defined in: packages/stax-xml/src/types.ts:49

EndDocumentEvent

Defined in: packages/stax-xml/src/types.ts:57

Event fired when the document ends parsing

Properties

type

type: "END_DOCUMENT"

Defined in: packages/stax-xml/src/types.ts:58

StartElementEvent

Defined in: packages/stax-xml/src/types.ts:66

Event fired when an XML element starts

Properties

type

type: "START_ELEMENT"

Defined in: packages/stax-xml/src/types.ts:67

name

name: string

Defined in: packages/stax-xml/src/types.ts:68

localName?

optional localName?: string

Defined in: packages/stax-xml/src/types.ts:69

prefix?

optional prefix?: string

Defined in: packages/stax-xml/src/types.ts:70

uri?

optional uri?: string

Defined in: packages/stax-xml/src/types.ts:71

attributes

attributes: Record<string, string>

Defined in: packages/stax-xml/src/types.ts:72

attributesWithPrefix?

optional attributesWithPrefix?: Record<string, AttributeInfo>

Defined in: packages/stax-xml/src/types.ts:73

EndElementEvent

Defined in: packages/stax-xml/src/types.ts:76

Properties

type

type: "END_ELEMENT"

Defined in: packages/stax-xml/src/types.ts:77

name

name: string

Defined in: packages/stax-xml/src/types.ts:78

localName?

optional localName?: string

Defined in: packages/stax-xml/src/types.ts:79

prefix?

optional prefix?: string

Defined in: packages/stax-xml/src/types.ts:80

uri?

optional uri?: string

Defined in: packages/stax-xml/src/types.ts:81

CharactersEvent

Defined in: packages/stax-xml/src/types.ts:84

Properties

type

type: "CHARACTERS"

Defined in: packages/stax-xml/src/types.ts:85

value

value: string

Defined in: packages/stax-xml/src/types.ts:86

CdataEvent

Defined in: packages/stax-xml/src/types.ts:89

Properties

type

type: "CDATA"

Defined in: packages/stax-xml/src/types.ts:90

value

value: string

Defined in: packages/stax-xml/src/types.ts:91

ErrorEvent

Defined in: packages/stax-xml/src/types.ts:94

Properties

type

type: "ERROR"

Defined in: packages/stax-xml/src/types.ts:95

error

error: Error

Defined in: packages/stax-xml/src/types.ts:96

XmlAttribute

Defined in: packages/stax-xml/src/types.ts:114

Attribute interface (for Writer)

Properties

prefix?

optional prefix?: string

Defined in: packages/stax-xml/src/types.ts:115

localName

localName: string

Defined in: packages/stax-xml/src/types.ts:116

uri?

optional uri?: string

Defined in: packages/stax-xml/src/types.ts:117

value

value: string

Defined in: packages/stax-xml/src/types.ts:118

NamespaceDeclaration

Defined in: packages/stax-xml/src/types.ts:125

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

Properties

prefix

prefix: string

Defined in: packages/stax-xml/src/types.ts:126

uri

uri: string

Defined in: packages/stax-xml/src/types.ts:127

ProcessingInstruction

Defined in: packages/stax-xml/src/types.ts:134

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

Properties

target

target: string

Defined in: packages/stax-xml/src/types.ts:135

data?

optional data?: string

Defined in: packages/stax-xml/src/types.ts:136

AttributeInfo

Defined in: packages/stax-xml/src/types.ts:142

Attribute information interface

Properties

value

value: string

Defined in: packages/stax-xml/src/types.ts:143

localName

localName: string

Defined in: packages/stax-xml/src/types.ts:144

prefix?

optional prefix?: string

Defined in: packages/stax-xml/src/types.ts:145

uri?

optional uri?: string

Defined in: packages/stax-xml/src/types.ts:146

WriteElementOptions

Defined in: packages/stax-xml/src/types.ts:354

Element writing options interface (for Writer)

Properties

prefix?

optional prefix?: string

Defined in: packages/stax-xml/src/types.ts:355

uri?

optional uri?: string

Defined in: packages/stax-xml/src/types.ts:356

attributes?

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

Defined in: packages/stax-xml/src/types.ts:357

selfClosing?

optional selfClosing?: boolean

Defined in: packages/stax-xml/src/types.ts:358

comment?

optional comment?: string

Defined in: packages/stax-xml/src/types.ts:359

ParserEventFilter

Defined in: packages/stax-xml/src/types.ts:362

Properties

includeAttributes

includeAttributes: boolean

Defined in: packages/stax-xml/src/types.ts:363

includeCharacters

includeCharacters: boolean

Defined in: packages/stax-xml/src/types.ts:364

includeCdata

includeCdata: boolean

Defined in: packages/stax-xml/src/types.ts:365

Type Aliases

XmlSyncInput

XmlSyncInput = string | Uint8Array | Iterable<Uint8Array>

Defined in: packages/stax-xml/src/XmlObject.ts:19

XML inputs that can be parsed without crossing an async boundary.

XmlAsyncInput

XmlAsyncInput = XmlSyncInput | AsyncIterable<Uint8Array> | ReadableStream<Uint8Array>

Defined in: packages/stax-xml/src/XmlObject.ts:22

XML inputs accepted by the convenience tree/object helpers.

XmlTreeNode

XmlTreeNode = XmlTreeElement | XmlTreeText | XmlTreeCdata

Defined in: packages/stax-xml/src/XmlObject.ts:52

XmlObjectValue

XmlObjectValue = string | XmlObjectRecord | XmlObjectArray

Defined in: packages/stax-xml/src/XmlObject.ts:75

Value stored in the compact object projection.

StreamEventType

StreamEventType = typeof StreamEventType[keyof typeof StreamEventType]

Defined in: packages/stax-xml/src/stream-reader-core.ts:6

Numeric XML stream event type.

StreamReaderSyncByteBatch

StreamReaderSyncByteBatch = readonly Uint8Array[]

Defined in: packages/stax-xml/src/stream-reader-core.ts:27

One synchronous byte batch consumed by StreamReaderSync.

StreamReaderSyncRawBatch

StreamReaderSyncRawBatch = StreamReaderSyncWordTableBatch | StreamReaderSyncFrameBatch | StreamReaderSyncSoaStringArenaBatch

Defined in: packages/stax-xml/src/stream-reader-core.ts:152

Experimental

Experimental raw batch traversal view returned by StreamReaderSync.nextRawBatch.

XmlEventType

XmlEventType = typeof XmlEventType[keyof typeof XmlEventType]

Defined in: packages/stax-xml/src/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: packages/stax-xml/src/types.ts:102

Discriminated Union type for developer use

DocumentMode

DocumentMode = "fragment" | "document"

Defined in: packages/stax-xml/src/types.ts:373

XML document conformance mode.

Variables

StreamEventType

const StreamEventType: object

Defined in: packages/stax-xml/src/stream-reader-core.ts:6

Event type constants exposed by stream readers.

Type Declaration

START_DOCUMENT

readonly START_DOCUMENT: 0 = 0

END_DOCUMENT

readonly END_DOCUMENT: 1 = 1

START_ELEMENT

readonly START_ELEMENT: 2 = 2

END_ELEMENT

readonly END_ELEMENT: 3 = 3

CHARACTERS

readonly CHARACTERS: 4 = 4

CDATA

readonly CDATA: 5 = 5

XmlEventType

const XmlEventType: object

Defined in: packages/stax-xml/src/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

createEventReader()

createEventReader(xmlStream, options?): EventReader

Defined in: packages/stax-xml/src/EventReader.ts:84

Parameters

xmlStream

ReadableStream<Uint8Array<ArrayBufferLike>>

options?

EventReaderOptions = {}

Returns

EventReader

parseXmlTreeSync()

parseXmlTreeSync(input, options?): XmlTreeDocument

Defined in: packages/stax-xml/src/XmlObject.ts:91

Parse XML into an order-preserving tree using a synchronous input.

Parameters

input

XmlSyncInput

options?

ParseXmlTreeOptions = {}

Returns

XmlTreeDocument

parseXmlTree()

parseXmlTree(input, options?): Promise<XmlTreeDocument>

Defined in: packages/stax-xml/src/XmlObject.ts:96

Parse XML into an order-preserving tree.

Parameters

input

XmlAsyncInput

options?

ParseXmlTreeOptions = {}

Returns

Promise<XmlTreeDocument>

parseXmlObjectSync()

parseXmlObjectSync(input, options?): XmlObjectRecord

Defined in: packages/stax-xml/src/XmlObject.ts:104

Parse XML into a compact JavaScript object using a synchronous input.

Parameters

input

XmlSyncInput

options?

ParseXmlObjectOptions = {}

Returns

XmlObjectRecord

parseXmlObject()

parseXmlObject(input, options?): Promise<XmlObjectRecord<XmlObjectValue>>

Defined in: packages/stax-xml/src/XmlObject.ts:112

Parse XML into a compact JavaScript object.

Parameters

input

XmlAsyncInput

options?

ParseXmlObjectOptions = {}

Returns

Promise<XmlObjectRecord<XmlObjectValue>>

isStartElement()

isStartElement(event): event is StartElementEvent

Defined in: packages/stax-xml/src/types.ts:297

Type guard function - Check if the event is a START_ELEMENT event

Parameters

event

AnyXmlEvent

XML event to check

Returns

event is StartElementEvent

true if the event is a START_ELEMENT event, false otherwise

isEndElement()

isEndElement(event): event is EndElementEvent

Defined in: packages/stax-xml/src/types.ts:306

Type guard function - Check if the event is an END_ELEMENT event

Parameters

event

AnyXmlEvent

XML event to check

Returns

event is EndElementEvent

true if the event is an END_ELEMENT event, false otherwise

isCharacters()

isCharacters(event): event is CharactersEvent

Defined in: packages/stax-xml/src/types.ts:315

Type guard function - Check if the event is a CHARACTERS event

Parameters

event

AnyXmlEvent

XML event to check

Returns

event is CharactersEvent

true if the event is a CHARACTERS event, false otherwise

isCdata()

isCdata(event): event is CdataEvent

Defined in: packages/stax-xml/src/types.ts:323

Type guard function - Check if the event is a CDATA event

Parameters

event

AnyXmlEvent

XML event to check

Returns

event is CdataEvent

true if the event is a CDATA event, false otherwise

isError()

isError(event): event is ErrorEvent

Defined in: packages/stax-xml/src/types.ts:331

Type guard function - Check if the event is an ERROR event

Parameters

event

AnyXmlEvent

XML event to check

Returns

event is ErrorEvent

true if the event is an ERROR event, false otherwise

isStartDocument()

isStartDocument(event): event is StartDocumentEvent

Defined in: packages/stax-xml/src/types.ts:339

Type guard function - Check if the event is a START_DOCUMENT event

Parameters

event

AnyXmlEvent

XML event to check

Returns

event is StartDocumentEvent

true if the event is a START_DOCUMENT event, false otherwise

isEndDocument()

isEndDocument(event): event is EndDocumentEvent

Defined in: packages/stax-xml/src/types.ts:347

Type guard function - Check if the event is an END_DOCUMENT event

Parameters

event

AnyXmlEvent

XML event to check

Returns

event is EndDocumentEvent

true if the event is an END_DOCUMENT event, false otherwise

References

default

Renames and re-exports WriterSync