BuilderOptions

Instance Constructors

new BuilderOptions(rootName: UndefOr[String] = js.undefined, renderOpts: UndefOr[RenderOptions] = js.undefined, indent: UndefOr[String] = js.undefined, xmldec: UndefOr[XmlDeclarationOptions] = js.undefined, newline: UndefOr[String] = js.undefined, doctype: UndefOr[String] = js.undefined, headless: UndefOr[Boolean] = js.undefined, allowSurrogateChars: UndefOr[Boolean] = js.undefined, cdata: UndefOr[Boolean] = js.undefined)
rootName
Root element name to be used in case explicitRoot is false or to override the root element name. (default root or the root key name)
renderOpts
Rendering options for xmlbuilder-js.pretty: prettify generated XML. (default { 'pretty': true, 'indent': ' ', 'newline': '\n' })
indent
Whitespace for indentation (only when pretty)
xmldec
XML declaration attributes (default { 'version': '1.0', 'encoding': 'UTF-8', 'standalone': true }). xmldec.version - A version number string, e.g. 1.0 xmldec.encoding - Encoding declaration, e.g. UTF-8 xmldec.standalone - Standalone document declaration: true or false
newline
Newline char (only when pretty)
doctype
Optional DTD. Eg. {'ext': 'hello.dtd'} (default null)
headless
Omit the XML header. Added in 0.4.3 (default: false)
allowSurrogateChars
Allows using characters from the Unicode surrogate blocks (default: false)
cdata
Wrap text nodes in
```
<![CDATA[ ... ]]>
```
Does not add
```
<![CDATA[ ... ]]>
```

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var allowSurrogateChars: UndefOr[Boolean]

Allows using characters from the Unicode surrogate blocks (default: false)
final def asInstanceOf[T0]: T0

Definition Classes
Any
var cdata: UndefOr[Boolean]

Wrap text nodes in
Wrap text nodes in
```
<![CDATA[ ... ]]>
```
Does not add
```
<![CDATA[ ... ]]>
```
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var doctype: UndefOr[String]

Optional DTD.
Optional DTD. Eg. {'ext': 'hello.dtd'} (default null)
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
var headless: UndefOr[Boolean]

Omit the XML header.
Omit the XML header. Added in 0.4.3 (default: false)
var indent: UndefOr[String]

Whitespace for indentation (only when pretty)
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
var newline: UndefOr[String]

Newline char (only when pretty)
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
var renderOpts: UndefOr[RenderOptions]

Rendering options for xmlbuilder-js.pretty: prettify generated XML.
Rendering options for xmlbuilder-js.pretty: prettify generated XML. (default { 'pretty': true, 'indent': ' ', 'newline': '\n' })
var rootName: UndefOr[String]

Root element name to be used in case explicitRoot is false or to override the root element name.
Root element name to be used in case explicitRoot is false or to override the root element name. (default root or the root key name)
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
var xmldec: UndefOr[XmlDeclarationOptions]

XML declaration attributes (default { 'version': '1.0', 'encoding': 'UTF-8', 'standalone': true }).
XML declaration attributes (default { 'version': '1.0', 'encoding': 'UTF-8', 'standalone': true }). xmldec.version - A version number string, e.g. 1.0 xmldec.encoding - Encoding declaration, e.g. UTF-8 xmldec.standalone - Standalone document declaration: true or false

Related Doc: package xml2js

class BuilderOptions extends Object

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

var allowSurrogateChars: UndefOr[Boolean]

final def asInstanceOf[T0]: T0

var cdata: UndefOr[Boolean]

def clone(): AnyRef

var doctype: UndefOr[String]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

var headless: UndefOr[Boolean]

var indent: UndefOr[String]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

final def ne(arg0: AnyRef): Boolean

var newline: UndefOr[String]

final def notify(): Unit

final def notifyAll(): Unit

def propertyIsEnumerable(v: String): Boolean

var renderOpts: UndefOr[RenderOptions]

var rootName: UndefOr[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def toLocaleString(): String

def toString(): String

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

var xmldec: UndefOr[XmlDeclarationOptions]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped