Kit
Type aliases

DiscriminatedUnionCodecConfig

DiscriminatedUnionCodecConfig<TDiscriminatorProperty, TDiscriminatorSize> = object

Defines the configuration for discriminated union codecs.

This configuration controls how the discriminator is stored and named.

Type Parameters

Type ParameterDefault typeDescription
TDiscriminatorProperty extends string"__kind"The property name of the discriminator.
TDiscriminatorSizeNumberCodec | NumberDecoder | NumberEncoderThe codec used for the discriminator prefix.

Properties

discriminator?

optional discriminator: TDiscriminatorProperty

The property name of the discriminator.

Default Value

__kind


size?

optional size: TDiscriminatorSize

The codec used to encode/decode the discriminator prefix.

Default Value

u8 prefix

On this page