getNullableEncoder

Call Signature

function getNullableEncoder<TFrom, TSize>(
    item,
    config,
): FixedSizeEncoder<TFrom | null, TSize>;

Returns an encoder for optional values, allowing null values to be encoded.

This encoder serializes an optional value using a configurable approach:

• By default, a u8 prefix is used (0 = null, 1 = present). This can be customized or disabled.
• If noneValue: 'zeroes' is set, null values are encoded as zeroes.
• If noneValue is a byte array, null values are replaced with the provided constant.

For more details, see getNullableCodec.

Type Parameters

Parameters

Returns

FixedSizeEncoder<TFrom | null, TSize>

A FixedSizeEncoder or VariableSizeEncoder for encoding nullable values.

Example

Encoding an optional number.

const encoder = getNullableEncoder(getU32Encoder());
 
encoder.encode(null); // 0x00
encoder.encode(42);   // 0x012a000000

See

getNullableCodec

Call Signature

function getNullableEncoder<TFrom>(
    item,
    config,
): FixedSizeEncoder<TFrom | null>;

Returns an encoder for optional values, allowing null values to be encoded.

This encoder serializes an optional value using a configurable approach:

• By default, a u8 prefix is used (0 = null, 1 = present). This can be customized or disabled.
• If noneValue: 'zeroes' is set, null values are encoded as zeroes.
• If noneValue is a byte array, null values are replaced with the provided constant.

For more details, see getNullableCodec.

Type Parameters

Parameters

Returns

FixedSizeEncoder<TFrom | null>

A FixedSizeEncoder or VariableSizeEncoder for encoding nullable values.

Example

Encoding an optional number.

const encoder = getNullableEncoder(getU32Encoder());
 
encoder.encode(null); // 0x00
encoder.encode(42);   // 0x012a000000

See

getNullableCodec

Call Signature

function getNullableEncoder<TFrom>(
    item,
    config,
): VariableSizeEncoder<TFrom | null>;

Returns an encoder for optional values, allowing null values to be encoded.

This encoder serializes an optional value using a configurable approach:

• By default, a u8 prefix is used (0 = null, 1 = present). This can be customized or disabled.
• If noneValue: 'zeroes' is set, null values are encoded as zeroes.
• If noneValue is a byte array, null values are replaced with the provided constant.

For more details, see getNullableCodec.

Type Parameters

Parameters

Returns

VariableSizeEncoder<TFrom | null>

A FixedSizeEncoder or VariableSizeEncoder for encoding nullable values.

Example

Encoding an optional number.

const encoder = getNullableEncoder(getU32Encoder());
 
encoder.encode(null); // 0x00
encoder.encode(42);   // 0x012a000000

See

getNullableCodec

Call Signature

function getNullableEncoder<TFrom>(
    item,
    config?,
): VariableSizeEncoder<TFrom | null>;

Returns an encoder for optional values, allowing null values to be encoded.

This encoder serializes an optional value using a configurable approach:

• By default, a u8 prefix is used (0 = null, 1 = present). This can be customized or disabled.
• If noneValue: 'zeroes' is set, null values are encoded as zeroes.
• If noneValue is a byte array, null values are replaced with the provided constant.

For more details, see getNullableCodec.

Type Parameters

Parameters

Returns

VariableSizeEncoder<TFrom | null>

A FixedSizeEncoder or VariableSizeEncoder for encoding nullable values.

Example

Encoding an optional number.

const encoder = getNullableEncoder(getU32Encoder());
 
encoder.encode(null); // 0x00
encoder.encode(42);   // 0x012a000000

See

getNullableCodec