Function getDiscriminatedUnionCodec

getDiscriminatedUnionCodec<
    const TVariants extends Variants<Codec<any, any>>,
    const TDiscriminatorProperty extends string = "__kind",
>(
    variants: TVariants,
    config?: DiscriminatedUnionCodecConfig<TDiscriminatorProperty, NumberCodec>,
): Codec<
    GetEncoderTypeFromVariants<TVariants, TDiscriminatorProperty>,
    GetDecoderTypeFromVariants<TVariants, TDiscriminatorProperty> & GetEncoderTypeFromVariants<
        TVariants,
        TDiscriminatorProperty,
    >,
>
Creates a discriminated union codec.
Type Parameters
- const TVariants extends Variants<Codec<any, any>>
- const TDiscriminatorProperty extends string = "__kind"
Parameters
- variants: TVariants
  The variant codecs of the discriminated union.
- config: DiscriminatedUnionCodecConfig<TDiscriminatorProperty, NumberCodec> = {}
  A set of config for the codec.
Returns Codec<
    GetEncoderTypeFromVariants<TVariants, TDiscriminatorProperty>,
    GetDecoderTypeFromVariants<TVariants, TDiscriminatorProperty> & GetEncoderTypeFromVariants<
        TVariants,
        TDiscriminatorProperty,
    >,
>
- Defined in packages/codecs-data-structures/src/discriminated-union.ts:162