Function getEnumCodec

getEnumCodec<TEnum extends EnumLookupObject>(
constructor: TEnum,
config?: Omit<EnumCodecConfig<NumberCodec>, "size">,
): FixedSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>, 1>
Creates an enum codec.
Type Parameters
- TEnum extends EnumLookupObject
Parameters
- constructor: TEnum
  The constructor of the enum.
- Optionalconfig: Omit<EnumCodecConfig<NumberCodec>, "size">
  A set of config for the codec.
Returns FixedSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>, 1>
- Defined in packages/codecs-data-structures/src/enum.ts:160
getEnumCodec<TEnum extends EnumLookupObject, TSize extends number>(
    constructor: TEnum,
    config: EnumCodecConfig<NumberCodec> & {
        size: FixedSizeNumberCodec<TSize>;
    },
): FixedSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>, TSize>
Creates an enum codec.
Type Parameters
- TEnum extends EnumLookupObject
- TSize extends number
Parameters
- constructor: TEnum
  The constructor of the enum.
- config: EnumCodecConfig<NumberCodec> & { size: FixedSizeNumberCodec<TSize> }
  A set of config for the codec.
Returns FixedSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>, TSize>
- Defined in packages/codecs-data-structures/src/enum.ts:164
getEnumCodec<TEnum extends EnumLookupObject>(
constructor: TEnum,
config?: EnumCodecConfig<NumberCodec>,
): VariableSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>>
Creates an enum codec.
Type Parameters
- TEnum extends EnumLookupObject
Parameters
- constructor: TEnum
  The constructor of the enum.
- Optionalconfig: EnumCodecConfig<NumberCodec>
  A set of config for the codec.
Returns VariableSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>>
- Defined in packages/codecs-data-structures/src/enum.ts:168

Function getEnumCodec

Type Parameters

Parameters

Returns FixedSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>, 1>

Type Parameters

Parameters

Returns FixedSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>, TSize>

Type Parameters

Parameters

Returns VariableSizeCodec<GetEnumFrom<TEnum>, GetEnumTo<TEnum>>

Settings