ClassToXmlOptions.md

xml-class-transformer / ClassToXmlOptions

Interface: ClassToXmlOptions

Hierarchy

• JS2XML

  ↳ ClassToXmlOptions

Table of contents

Properties

• attributeNameFn
• attributeValueFn
• attributesFn
• attributesKey
• avoidDoubleSanitization
• cdataFn
• cdataKey
• commentFn
• commentKey
• compact
• declaration
• declarationKey
• doctypeFn
• doctypeKey
• elementNameFn
• elementsKey
• fullTagEmptyElement
• fullTagEmptyElementFn
• ignoreAttributes
• ignoreCdata
• ignoreComment
• ignoreDeclaration
• ignoreDoctype
• ignoreInstruction
• ignoreText
• indentAttributes
• indentCdata
• indentInstruction
• indentText
• instructionFn
• instructionKey
• instructionNameFn
• nameKey
• noQuotesForNativeAttributes
• parentKey
• spaces
• textFn
• textKey
• typeKey

Properties

attributeNameFn

• Optional attributeNameFn: (attributeName: string, attributeValue: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (attributeName, attributeValue, currentElementName, currentElementObj): void

Parameters

Name	Type
attributeName	string
attributeValue	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.attributeNameFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:119

---

attributeValueFn

• Optional attributeValueFn: (attributeValue: string, attributeName: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (attributeValue, attributeName, currentElementName, currentElementObj): void

Parameters

Name	Type
attributeValue	string
attributeName	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.attributeValueFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:125

---

attributesFn

• Optional attributesFn: (value: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (value, currentElementName, currentElementObj): void

Parameters

Name	Type
value	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.attributesFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:131

---

attributesKey

• Optional attributesKey: string

Inherited from

xmljs.Options.JS2XML.attributesKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:148

---

avoidDoubleSanitization

• Optional avoidDoubleSanitization: boolean

If set to true, it will not sanitize already escaped characters.

If this is not set or set to false, then a string like & & will be converted to & &. If this is set to true, then & & will be converted to & &.

Default

false

Inherited from

xmljs.Options.JS2XML.avoidDoubleSanitization

Defined in

node_modules/xml-js-v2/types/index.d.ts:101

---

cdataFn

• Optional cdataFn: (value: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (value, currentElementName, currentElementObj): void

Parameters

Name	Type
value	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.cdataFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:109

---

cdataKey

• Optional cdataKey: string

Inherited from

xmljs.Options.JS2XML.cdataKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:150

---

commentFn

• Optional commentFn: (value: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (value, currentElementName, currentElementObj): void

Parameters

Name	Type
value	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.commentFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:110

---

commentKey

• Optional commentKey: string

Inherited from

xmljs.Options.JS2XML.commentKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:152

---

compact

• Optional compact: boolean

Inherited from

xmljs.Options.JS2XML.compact

Defined in

node_modules/xml-js-v2/types/index.d.ts:86

---

declaration

• Optional declaration: boolean | { attributes?: DeclarationAttributes }

Whether to include the default declaration line <?xml version="1.0" encoding="UTF-8"?> or not.

Default

true

Defined in

src/types.ts:236

---

declarationKey

• Optional declarationKey: string

Inherited from

xmljs.Options.JS2XML.declarationKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:146

---

doctypeFn

• Optional doctypeFn: (value: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (value, currentElementName, currentElementObj): void

Parameters

Name	Type
value	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.doctypeFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:102

---

doctypeKey

• Optional doctypeKey: string

Inherited from

xmljs.Options.JS2XML.doctypeKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:151

---

elementNameFn

• Optional elementNameFn: (value: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (value, currentElementName, currentElementObj): void

Parameters

Name	Type
value	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.elementNameFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:118

---

elementsKey

• Optional elementsKey: string

Inherited from

xmljs.Options.JS2XML.elementsKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:156

---

fullTagEmptyElement

• Optional fullTagEmptyElement: boolean

Inherited from

xmljs.Options.JS2XML.fullTagEmptyElement

Defined in

node_modules/xml-js-v2/types/index.d.ts:91

---

fullTagEmptyElementFn

• Optional fullTagEmptyElementFn: (currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (currentElementName, currentElementObj): void

Parameters

Name	Type
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.fullTagEmptyElementFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:132

---

ignoreAttributes

• Optional ignoreAttributes: boolean

Inherited from

xmljs.Options.JS2XML.ignoreAttributes

Defined in

node_modules/xml-js-v2/types/index.d.ts:138

---

ignoreCdata

• Optional ignoreCdata: boolean

Inherited from

xmljs.Options.JS2XML.ignoreCdata

Defined in

node_modules/xml-js-v2/types/index.d.ts:140

---

ignoreComment

• Optional ignoreComment: boolean

Inherited from

xmljs.Options.JS2XML.ignoreComment

Defined in

node_modules/xml-js-v2/types/index.d.ts:139

---

ignoreDeclaration

• Optional ignoreDeclaration: boolean

Inherited from

xmljs.Options.JS2XML.ignoreDeclaration

Defined in

node_modules/xml-js-v2/types/index.d.ts:136

---

ignoreDoctype

• Optional ignoreDoctype: boolean

Inherited from

xmljs.Options.JS2XML.ignoreDoctype

Defined in

node_modules/xml-js-v2/types/index.d.ts:141

---

ignoreInstruction

• Optional ignoreInstruction: boolean

Inherited from

xmljs.Options.JS2XML.ignoreInstruction

Defined in

node_modules/xml-js-v2/types/index.d.ts:137

---

ignoreText

• Optional ignoreText: boolean

Inherited from

xmljs.Options.JS2XML.ignoreText

Defined in

node_modules/xml-js-v2/types/index.d.ts:142

---

indentAttributes

• Optional indentAttributes: boolean

Inherited from

xmljs.Options.JS2XML.indentAttributes

Defined in

node_modules/xml-js-v2/types/index.d.ts:89

---

indentCdata

• Optional indentCdata: boolean

Inherited from

xmljs.Options.JS2XML.indentCdata

Defined in

node_modules/xml-js-v2/types/index.d.ts:88

---

indentInstruction

• Optional indentInstruction: boolean

Inherited from

xmljs.Options.JS2XML.indentInstruction

Defined in

node_modules/xml-js-v2/types/index.d.ts:90

---

indentText

• Optional indentText: boolean

Inherited from

xmljs.Options.JS2XML.indentText

Defined in

node_modules/xml-js-v2/types/index.d.ts:87

---

instructionFn

• Optional instructionFn: (instructionValue: string, instructionName: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (instructionValue, instructionName, currentElementName, currentElementObj): void

Parameters

Name	Type
instructionValue	string
instructionName	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.instructionFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:103

---

instructionKey

• Optional instructionKey: string

Inherited from

xmljs.Options.JS2XML.instructionKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:147

---

instructionNameFn

• Optional instructionNameFn: (instructionName: string, instructionValue: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (instructionName, instructionValue, currentElementName, currentElementObj): void

Parameters

Name	Type
instructionName	string
instructionValue	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.instructionNameFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:112

---

nameKey

• Optional nameKey: string

Inherited from

xmljs.Options.JS2XML.nameKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:155

---

noQuotesForNativeAttributes

• Optional noQuotesForNativeAttributes: boolean

Inherited from

xmljs.Options.JS2XML.noQuotesForNativeAttributes

Defined in

node_modules/xml-js-v2/types/index.d.ts:92

---

parentKey

• Optional parentKey: string

Inherited from

xmljs.Options.JS2XML.parentKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:153

---

spaces

• Optional spaces: string | number

Inherited from

xmljs.Options.JS2XML.spaces

Defined in

node_modules/xml-js-v2/types/index.d.ts:85

---

textFn

• Optional textFn: (value: string, currentElementName: string, currentElementObj: object) => void

Type declaration

▸ (value, currentElementName, currentElementObj): void

Parameters

Name	Type
value	string
currentElementName	string
currentElementObj	object

Returns

void

Inherited from

xmljs.Options.JS2XML.textFn

Defined in

node_modules/xml-js-v2/types/index.d.ts:111

---

textKey

• Optional textKey: string

Inherited from

xmljs.Options.JS2XML.textKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:149

---

typeKey

• Optional typeKey: string

Inherited from

xmljs.Options.JS2XML.typeKey

Defined in

node_modules/xml-js-v2/types/index.d.ts:154