Interface ParseXmlHandler<T>

A handler for XML deserialization.

interface ParseXmlHandler<T> {
    cDataNode(str: string): void;
    endDocument(): T & XmlElement<T>;
    endElement(): void;
    startDocument(): void;
    startElement(name: QName, attributes: Attributes): void;
    textNode(str: string): void;
}

Type Parameters

T

Implemented by

ParseXmlHandlerImpl

Index

Methods

cDataNode endDocument endElement startDocument startElement textNode

Methods

cDataNode

cDataNode(str: string): void
Provides a raw substring as a cdata node. This text is not expected to be decoded.
Parameters
- str: string
Returns void
- Defined in vinyl-xml/src/xml/ParseXmlHandler.ts:48

endDocument

endDocument(): T & XmlElement<T>
A document has completed parsing, the final object is ready.

Returns T & XmlElement<T>
- Defined in vinyl-xml/src/xml/ParseXmlHandler.ts:20

endElement

endElement(): void
Invoked after an element closing tag.

Returns void
- Defined in vinyl-xml/src/xml/ParseXmlHandler.ts:33

startDocument

startDocument(): void
A new document has begun.

Returns void
- Defined in vinyl-xml/src/xml/ParseXmlHandler.ts:15

startElement

startElement(name: QName, attributes: Attributes): void
Invoked when a new element has been started, after the element's attributes have been read.
Parameters
- name: QName
  An object representing the element's name and namespace.
- attributes: Attributes
  The attributes associated with the currently opening element.
Returns void
- Defined in vinyl-xml/src/xml/ParseXmlHandler.ts:28

textNode

textNode(str: string): void
Provides a raw substring as a text node. The given text is expected to be decoded using decodeEntities.
Parameters
- str: string
Returns void
- Defined in vinyl-xml/src/xml/ParseXmlHandler.ts:41