Zum Hauptinhalt springen

XmlSerializerTransformOptions

Properties​

createEmptyNodes?​

optional createEmptyNodes: boolean

Should empty nodes be created?

createEmptyNodes?: boolean = true;

Example (default)​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root")
const xml = serializer.serialize({
    node1: "test",
    emptyText: "",
    node2: "test2",
})

Ergebnis:

<root>
    <node1>test</node1>
    <emptyText></emptyText>
    <node2>test2</node2>
</root>

Example (false)​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root", {
    createEmptyNodes: false
})
const xml = serializer.serialize({
    node1: "test",
    emptyText: "",
    node2: "test2",
})

Ergebnis:

<root>
    <node1>test</node1>
    <node2>test2</node2>
</root>

convertNumericToString?​

optional convertNumericToString: boolean

Use otris logic (context.convertNumericToString) for formatting numbers?

convertNumericToString?: boolean = false;

Example (default)​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root")
const xml = serializer.serialize({
    node1: 123456.78,
})

Ergebnis:

<root>
    <node1>123456.78</node1>
</root>

Example (false)​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root", {
    convertNumericToString: true
})
const xml = serializer.serialize({
    node1: 123456.78,
})

Ergebnis:

<root>
    <node1>123.456,78</node1>
</root>

convertDateToString?​

optional convertDateToString: boolean

Use otris logic (context.convertDateToString) for formatting dates? If false, dates are converted into a string by using toLocaleString().

convertDateToString?: boolean = false;

Example (default)​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root")
const xml = serializer.serialize({
    node1: new Date(2000, 0, 1),
})

Ergebnis:

<root>
    <node1>1.1.2000</node1>
</root>

Example (false)​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root", {
    convertDateToString: true
})
const xml = serializer.serialize({
    node1: new Date(2000, 0, 1),
})

Ergebnis:

<root>
    <node1>01.01.2000</node1>
</root>

dateFormat?​

optional dateFormat: string

A Date pattern, which should be used by otris function (util.convertDateToString).

dateFormat?: string = "";
info

If this option is set, the convertDateToString will be ignored!

Example​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root", {
    dateFormat: "yyyy-mm-dd"
})
const xml = serializer.serialize({
    node1: new Date(2000, 0, 1),
})

Ergebnis:

<root>
    <node1>2000-01-01</node1>
</root>

specialHandlingPrefix?​

optional specialHandlingPrefix: string

Internal option for handling attributes like attributes, value pr children.

specialHandlingPrefix?: string = "_";

Example​

const { XmlSerializer } = require("ou.sp.XmlSerializer");
const serializer = new XmlSerializer("root", {
    specialHandlingPrefix: "$"
})
const xml = serializer.serialize({
    node1: {
        $attributes: {
            id: "someId"
        },
        $value: "test"
    },
})
<root>
    <node1 id="someId">test</node1>
</root>