Function getLiteralUnionEncoder

getLiteralUnionEncoder<const TVariants extends readonly Variant[]>(
variants: TVariants,
): FixedSizeEncoder<GetTypeFromVariants<TVariants>, 1>
Creates a literal union encoder.
Type Parameters
- const TVariants extends readonly Variant[]
Parameters
- variants: TVariants
  The variant encoders of the literal union.
Returns FixedSizeEncoder<GetTypeFromVariants<TVariants>, 1>
- Defined in packages/codecs-data-structures/dist/types/literal-union.d.ts:19
getLiteralUnionEncoder<
    const TVariants extends readonly Variant[],
    TSize extends number,
>(
    variants: TVariants,
    config: LiteralUnionCodecConfig<NumberEncoder> & {
        size: FixedSizeNumberEncoder<TSize>;
    },
): FixedSizeEncoder<GetTypeFromVariants<TVariants>, TSize>
Creates a literal union encoder.
Type Parameters
- const TVariants extends readonly Variant[]
- TSize extends number
Parameters
- variants: TVariants
  The variant encoders of the literal union.
- config: LiteralUnionCodecConfig<NumberEncoder> & { size: FixedSizeNumberEncoder<TSize> }
  A set of config for the encoder.
Returns FixedSizeEncoder<GetTypeFromVariants<TVariants>, TSize>
- Defined in packages/codecs-data-structures/dist/types/literal-union.d.ts:20
getLiteralUnionEncoder<const TVariants extends readonly Variant[]>(
variants: TVariants,
config?: LiteralUnionCodecConfig<NumberEncoder>,
): VariableSizeEncoder<GetTypeFromVariants<TVariants>>
Creates a literal union encoder.
Type Parameters
- const TVariants extends readonly Variant[]
Parameters
- variants: TVariants
  The variant encoders of the literal union.
- Optionalconfig: LiteralUnionCodecConfig<NumberEncoder>
  A set of config for the encoder.
Returns VariableSizeEncoder<GetTypeFromVariants<TVariants>>
- Defined in packages/codecs-data-structures/dist/types/literal-union.d.ts:23

Function getLiteralUnionEncoder

Type Parameters

Parameters

Returns FixedSizeEncoder<GetTypeFromVariants<TVariants>, 1>

Type Parameters

Parameters

Returns FixedSizeEncoder<GetTypeFromVariants<TVariants>, TSize>

Type Parameters

Parameters

Returns VariableSizeEncoder<GetTypeFromVariants<TVariants>>

Settings