Class XmlSerializer

XML serializer for node.

Hierarchy (View Summary)

XmlBaseSerializer
- XmlSerializer

Index

Constructors

Properties

Accessors

normalizerFactory

Methods

_normalize _serialize serialize

Constructors

constructor

new XmlSerializer(
normalizerFactory: Serialize.XML.Normalize.Factory,
): XmlSerializer
Parameters
- normalizerFactory: Serialize.XML.Normalize.Factory
Returns XmlSerializer

Throws
UnsupportedFormatError if normalizerFactory.spec does not support Format.XML.
Inherited from XmlBaseSerializer.constructor
- Defined in src/serialize/xmlBaseSerializer.ts:37

Properties

`Static` `Readonly`cannot

cannot: Cannot = ...

Indicates whether this functionality cannot act.

false if this functionality can act; otherwise, describes which optional dependencies are unavailable and prevent it from doing so.

Accessors

normalizerFactory

get normalizerFactory(): Serialize.XML.Normalize.Factory
Returns Serialize.XML.Normalize.Factory
Inherited from XmlBaseSerializer.normalizerFactory
- Defined in src/serialize/xmlBaseSerializer.ts:46

Methods

`Protected`_normalize

_normalize(bom: Models.Bom, options?: NormalizerOptions): Element
Parameters
- bom: Models.Bom
- options: NormalizerOptions = {}
Returns Element

Throws
Error
Inherited from XmlBaseSerializer._normalize
- Defined in src/serialize/xmlBaseSerializer.ts:50

`Protected`_serialize

_serialize(normalizedBom: Element, options?: SerializerOptions): string
Parameters
- normalizedBom: Element
- options: SerializerOptions = {}
Returns string

Throws
MissingOptionalDependencyError

Throws
Error
Overrides XmlBaseSerializer._serialize
- Defined in src/serialize/xmlSerializer.node.ts:46

serialize

serialize(
bom: Models.Bom,
options?: SerializerOptions & NormalizerOptions,
): string
Parameters
- bom: Models.Bom
- Optionaloptions: SerializerOptions & NormalizerOptions
Returns string

Throws
MissingOptionalDependencyError, when a required dependency was not installed

Throws
Error
Inherited from XmlBaseSerializer.serialize
- Defined in src/serialize/baseSerializer.ts:67