getBinaryFixedPointCodec

function getBinaryFixedPointCodec<
    TSignedness,
    TTotalBits,
    TFractionalBits,
>(
    signedness,
    totalBits,
    fractionalBits,
    config?,
): FixedSizeCodec<
    BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>,
    BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>,
    BytesForTotalBits<TTotalBits>
>;

Returns a codec for BinaryFixedPoint values of a specific shape, combining getBinaryFixedPointEncoder and getBinaryFixedPointDecoder.

Type Parameters

Type Parameter
TSignedness extends Signedness
TTotalBits extends number
TFractionalBits extends number

Parameters

ParameterType
signednessTSignedness
totalBitsTTotalBits
fractionalBitsTFractionalBits
config?FixedPointCodecConfig

Returns

FixedSizeCodec<BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>, BinaryFixedPoint<TSignedness, TTotalBits, TFractionalBits>, BytesForTotalBits<TTotalBits>>

Example

const codec = getBinaryFixedPointCodec('signed', 16, 15);
const bytes = codec.encode(binaryFixedPoint('signed', 16, 15)('0.5'));
const value = codec.decode(bytes); // represents 0.5

See

On this page