Type aliases
EnumCodecConfig
EnumCodecConfig<
TDiscriminator> =object
Defines the configuration options for enum codecs.
The size option determines the numerical encoding used for the enum's discriminant.
By default, enums are stored as a u8 (1 byte).
The useValuesAsDiscriminators option allows mapping the actual enum values
as discriminators instead of using their positional index.
Type Parameters
| Type Parameter | Description |
|---|---|
TDiscriminator extends NumberCodec | NumberDecoder | NumberEncoder | A number codec, encoder, or decoder used for the discriminant. |
Properties
size?
optionalsize:TDiscriminator
The codec used to encode/decode the enum discriminator.
Default Value
u8 discriminator.
useValuesAsDiscriminators?
optionaluseValuesAsDiscriminators:boolean
If set to true, the enum values themselves will be used as discriminators.
This is only valid for numerical enum values.
Default Value
false