getEncodedSize

function getEncodedSize<TFrom>(value, encoder): number;

Gets the encoded size of a given value in bytes using the provided encoder.

Type Parameters

Type ParameterDescription
TFromThe type of the value to encode.

Parameters

ParameterTypeDescription
valueTFromThe value to be encoded.
encoder| { fixedSize: number; } | { getSizeFromValue: (value) => number; }The encoder used to determine the encoded size.

Returns

number

The size of the encoded value in bytes.

Example

const fixedSizeEncoder = { fixedSize: 4 };
getEncodedSize(123, fixedSizeEncoder); // Returns 4.
 
const variableSizeEncoder = { getSizeFromValue: (value: string) => value.length };
getEncodedSize("hello", variableSizeEncoder); // Returns 5.

See

Encoder

On this page