Kit
Type aliases

LiteralUnionCodecConfig

LiteralUnionCodecConfig<TDiscriminator> = object

Defines the configuration options for literal union codecs.

A literal union codec encodes values from a predefined set of literals. The size option determines the numerical encoding used for the discriminant. By default, literals are stored as a u8 (1 byte).

Type Parameters

Type ParameterDefault typeDescription
TDiscriminatorNumberCodec | NumberDecoder | NumberEncoderA number codec, encoder, or decoder used for the discriminant.

Properties

size?

optional size: TDiscriminator

The codec used to encode/decode the discriminator.

Default Value

u8 discriminator.

On this page