Function getEnumEncoder

getEnumEncoder<TEnum extends EnumLookupObject>(
constructor: TEnum,
config?: Omit<EnumCodecConfig<NumberEncoder>, "size">,
): FixedSizeEncoder<GetEnumFrom<TEnum>, 1>
Creates an enum encoder.
Type Parameters
- TEnum extends EnumLookupObject
Parameters
- constructor: TEnum
  The constructor of the enum.
- Optionalconfig: Omit<EnumCodecConfig<NumberEncoder>, "size">
  A set of config for the encoder.
Returns FixedSizeEncoder<GetEnumFrom<TEnum>, 1>
- Defined in packages/codecs-data-structures/src/enum.ts:64
getEnumEncoder<TEnum extends EnumLookupObject, TSize extends number>(
    constructor: TEnum,
    config: EnumCodecConfig<NumberEncoder> & {
        size: FixedSizeNumberEncoder<TSize>;
    },
): FixedSizeEncoder<GetEnumFrom<TEnum>, TSize>
Creates an enum encoder.
Type Parameters
- TEnum extends EnumLookupObject
- TSize extends number
Parameters
- constructor: TEnum
  The constructor of the enum.
- config: EnumCodecConfig<NumberEncoder> & { size: FixedSizeNumberEncoder<TSize> }
  A set of config for the encoder.
Returns FixedSizeEncoder<GetEnumFrom<TEnum>, TSize>
- Defined in packages/codecs-data-structures/src/enum.ts:68
getEnumEncoder<TEnum extends EnumLookupObject>(
constructor: TEnum,
config?: EnumCodecConfig<NumberEncoder>,
): VariableSizeEncoder<GetEnumFrom<TEnum>>
Creates an enum encoder.
Type Parameters
- TEnum extends EnumLookupObject
Parameters
- constructor: TEnum
  The constructor of the enum.
- Optionalconfig: EnumCodecConfig<NumberEncoder>
  A set of config for the encoder.
Returns VariableSizeEncoder<GetEnumFrom<TEnum>>
- Defined in packages/codecs-data-structures/src/enum.ts:72

Function getEnumEncoder

Type Parameters

Parameters

Returns FixedSizeEncoder<GetEnumFrom<TEnum>, 1>

Type Parameters

Parameters

Returns FixedSizeEncoder<GetEnumFrom<TEnum>, TSize>

Type Parameters

Parameters

Returns VariableSizeEncoder<GetEnumFrom<TEnum>>

Settings