Class JsonSerializer

Multi purpose Json serializer.

Hierarchy (View Summary)

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

Index

Constructors

Properties

Accessors

normalizerFactory

Methods

_normalize _serialize serialize

Constructors

constructor

new JsonSerializer(
normalizerFactory: Serialize.JSON.Normalize.Factory,
): 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:47

Properties

`Static` `Readonly`cannot

cannot: Cannot = false

Indicates whether this functionality cannot act.

Always false for JSON functionality: no optional dependencies are involved, the platform-native JSON.stringify is used.

Accessors

normalizerFactory

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

Methods

`Protected`_normalize

_normalize(
bom: Models.Bom,
options?: NormalizerOptions,
): 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:60

`Protected`_serialize

_serialize(
bom: Serialize.JSON.Types.Normalized.Bom,
__namedParameters?: SerializerOptions,
): string
Parameters
- bom: Serialize.JSON.Types.Normalized.Bom
- __namedParameters: SerializerOptions = {}
Returns string

Throws
Error
Overrides BaseSerializer._serialize
- Defined in src/serialize/jsonSerializer.ts:68

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