Zum Hauptinhalt springen

XmlSerializer

Helper Class for creating XML-Files.

Constructors​

Constructor​

new XmlSerializer(rootNode, transformOptions?, document?, domParser?): XmlSerializer

Creates an instance of XmlSerializer.

tipp

Alle möglichen Transform Optionen, siehe XmlSerializerTransformOptions

new XmlSerializer(
    rootNode: string,
    transformOptions?: XmlSerializerTransformOptions,
    document?: DOMDocument,
    domParser?: DOMParser
): XmlSerializer

Parameters​

rootNode​

string

Der Hauptknoten der XML-Datei

transformOptions?​

XmlSerializerTransformOptions

Optionen zum Transformieren der XML, siehe XmlSerializerTransformOptions

document?​

DOMDocument

Ein bereits existierendes DOMDocument (Optional)

domParser?​

DOMParser

Klasse für DOMParser (IoC) (Optional)

Returns​

XmlSerializer

Example​

Simple Example

const { XmlSerializer } = require("ou.sp.XmlSerializer");
context.returnValue = new XmlSerializer("root").serialize();

Erweitertes Example:

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const transformOptions = {
    createEmptyNodes: false,
    convertDateToString: true,
    dateFormat: "dd.mm.yyyy"
}
context.returnValue = new XmlSerializer("root", transformOptions).serialize();

Methods​

serialize()​

serialize(json): XmlSerializerResult

Konvertiert ein JSON -Objekt und gibt ein XmlSerializerResult Instanz zurück, siehe XmlSerializerResult.

serialize(json: Object): XmlSerializerResult

Parameters​

json​

XmlSerializableObject

A JSON-Object.

Returns​

XmlSerializerResult

Returns a new XmlSerializerResult instance.

Example​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root")
const result = serializer.serialize({
    node1: "Test1",
    node2: "Test2",
})
// Result as XML-String
const xml = result.toString();

// <root>
//     <node1>Test1</node1>
//     <node2>Test2</node2>
// </root>

// Save XML to file system
try {
     const saved = result.save("D:\\tmp\\test.xml");
} catch (error) {
     // error.message -> DOMParser error
}

cdata()​

static cdata(value): string

Converts a string into a CDATA string

XmlSerializer.cdata(value: string): string

Parameters​

value​

string

A string that should be converted

Returns​

string

A string like <![CDATA[value]]>

Example​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const cdata = XmlSerializer.cdata("<Nachricht>Markup<Nachricht>")
// <![CDATA[<Nachricht>Markup<Nachricht>]]>