Class JsonSerializer

Multi purpose Json serializer.

Hierarchy (view full)

BaseSerializer<Serialize.JSON.Types.Normalized.Bom>
- JsonSerializer

Index

Constructors

Properties

#normalizerFactory

Accessors

normalizerFactory

Methods

#getAllBomRefs #normalize _normalize _serialize serialize

Constructors

constructor

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

Properties

`Private` `Readonly` #normalizerFactory

#normalizerFactory: Serialize.JSON.Normalize.Factory

Accessors

normalizerFactory

get normalizerFactory(): Serialize.JSON.Normalize.Factory
Returns Serialize.JSON.Normalize.Factory
- Defined in src/serialize/jsonSerializer.ts:46

Methods

`Private` #getAllBomRefs

#getAllBomRefs(bom): Generator<BomRef, any, unknown>
Parameters
- bom: Models.Bom
Returns Generator<BomRef, any, unknown>
Inherited from BaseSerializer.#getAllBomRefs
- Defined in src/serialize/baseSerializer.ts:26

`Private` #normalize

#normalize(bom, options?): Serialize.JSON.Types.Normalized.Bom
Parameters
- bom: Models.Bom
- Optional options: NormalizerOptions
Returns Serialize.JSON.Types.Normalized.Bom
Throws
Error
Inherited from BaseSerializer.#normalize
- Defined in src/serialize/baseSerializer.ts:49

`Protected` _normalize

_normalize(bom, options?): Serialize.JSON.Types.Normalized.Bom
Parameters
- bom: Models.Bom
- options: NormalizerOptions = {}
Returns Serialize.JSON.Types.Normalized.Bom
Throws
Error
Overrides BaseSerializer._normalize
- Defined in src/serialize/jsonSerializer.ts:50

`Protected` _serialize

_serialize(bom, __namedParameters?): string
Parameters
- bom: Serialize.JSON.Types.Normalized.Bom
- __namedParameters: SerializerOptions = {}
Returns string
Throws
Error
Overrides BaseSerializer._serialize
- Defined in src/serialize/jsonSerializer.ts:58

`Readonly` serialize

serialize(bom, options?): string
Readonly
Parameters
- bom: Models.Bom
- Optional options: SerializerOptions & NormalizerOptions
Returns string
Throws
Error
Inherited from BaseSerializer.serialize
- Defined in src/serialize/baseSerializer.ts:65