Function getEnumDecoder

getEnumDecoder<TEnum extends EnumLookupObject>(
constructor: TEnum,
config?: Omit<EnumCodecConfig<NumberDecoder>, "size">,
): FixedSizeDecoder<GetEnumTo<TEnum>, 1>
Creates an enum decoder.
Type Parameters
- TEnum extends EnumLookupObject
Parameters
- constructor: TEnum
  The constructor of the enum.
- Optionalconfig: Omit<EnumCodecConfig<NumberDecoder>, "size">
  A set of config for the decoder.
Returns FixedSizeDecoder<GetEnumTo<TEnum>, 1>
- Defined in packages/codecs-data-structures/dist/types/enum.d.ts:35
getEnumDecoder<TEnum extends EnumLookupObject, TSize extends number>(
    constructor: TEnum,
    config: EnumCodecConfig<NumberDecoder> & {
        size: FixedSizeNumberDecoder<TSize>;
    },
): FixedSizeDecoder<GetEnumTo<TEnum>, TSize>
Creates an enum decoder.
Type Parameters
- TEnum extends EnumLookupObject
- TSize extends number
Parameters
- constructor: TEnum
  The constructor of the enum.
- config: EnumCodecConfig<NumberDecoder> & { size: FixedSizeNumberDecoder<TSize> }
  A set of config for the decoder.
Returns FixedSizeDecoder<GetEnumTo<TEnum>, TSize>
- Defined in packages/codecs-data-structures/dist/types/enum.d.ts:36
getEnumDecoder<TEnum extends EnumLookupObject>(
constructor: TEnum,
config?: EnumCodecConfig<NumberDecoder>,
): VariableSizeDecoder<GetEnumTo<TEnum>>
Creates an enum decoder.
Type Parameters
- TEnum extends EnumLookupObject
Parameters
- constructor: TEnum
  The constructor of the enum.
- Optionalconfig: EnumCodecConfig<NumberDecoder>
  A set of config for the decoder.
Returns VariableSizeDecoder<GetEnumTo<TEnum>>
- Defined in packages/codecs-data-structures/dist/types/enum.d.ts:39

Function getEnumDecoder

Type Parameters

Parameters

Returns FixedSizeDecoder<GetEnumTo<TEnum>, 1>

Type Parameters

Parameters

Returns FixedSizeDecoder<GetEnumTo<TEnum>, TSize>

Type Parameters

Parameters

Returns VariableSizeDecoder<GetEnumTo<TEnum>>

Settings