Class XmlBaseSerializer`Abstract`

Base XML serializer.

Hierarchy (View Summary)

BaseSerializer<Element>
- XmlBaseSerializer
  - XmlSerializer

Index

Constructors

Accessors

normalizerFactory

Methods

_normalize _serialize serialize

Constructors

constructor

new XmlBaseSerializer(
normalizerFactory: Serialize.XML.Normalize.Factory,
): XmlBaseSerializer
Parameters
- normalizerFactory: Serialize.XML.Normalize.Factory
Returns XmlBaseSerializer
Throws
UnsupportedFormatError if normalizerFactory.spec does not support Format.XML.
Overrides BaseSerializer.constructor
- Defined in src/serialize/xmlBaseSerializer.ts:37

Accessors

normalizerFactory

get normalizerFactory(): Serialize.XML.Normalize.Factory
Returns Serialize.XML.Normalize.Factory
- 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
Overrides BaseSerializer._normalize
- Defined in src/serialize/xmlBaseSerializer.ts:50

`Protected` `Abstract`_serialize

_serialize(normalizedBom: Element, options?: SerializerOptions): string
Parameters
- normalizedBom: Element
- Optionaloptions: SerializerOptions
Returns string
Throws
Error
Inherited from BaseSerializer._serialize
- Defined in src/serialize/baseSerializer.ts:82

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 BaseSerializer.serialize
- Defined in src/serialize/baseSerializer.ts:67