getSetEncoder

Call Signature

function getSetEncoder<TFrom>(
    item,
    config,
): FixedSizeEncoder<Set<TFrom>, 0>;

Returns an encoder for sets of items.

This encoder serializes Set<T> values by encoding each item using the provided item encoder. The number of items is stored as a prefix using a u32 codec by default.

For more details, see getSetCodec.

Type Parameters

Type Parameter	Description
`TFrom`	The type of the items in the set before encoding.

Parameters

Parameter	Type	Description
`item`	`Encoder`<`TFrom`>	The encoder to use for each set item.
`config`	`SetCodecConfig`<`NumberEncoder`> & `object`	Optional configuration specifying the size strategy.

Returns

FixedSizeEncoder<Set<TFrom>, 0>

An Encoder<Set<TFrom>> for encoding sets of items.

Example

Encoding a set of u8 numbers.

const encoder = getSetEncoder(getU8Encoder());
const bytes = encoder.encode(new Set([1, 2, 3]));
// 0x03000000010203
//   |       └-- 3 items of 1 byte each.
//   └-- 4-byte prefix indicating 3 items.

See

getSetCodec

Call Signature

function getSetEncoder<TFrom>(
    item,
    config,
): FixedSizeEncoder<Set<TFrom>>;

Returns an encoder for sets of items.

This encoder serializes Set<T> values by encoding each item using the provided item encoder. The number of items is stored as a prefix using a u32 codec by default.

For more details, see getSetCodec.

Type Parameters

Type Parameter	Description
`TFrom`	The type of the items in the set before encoding.

Parameters

Parameter	Type	Description
`item`	`FixedSizeEncoder`<`TFrom`>	The encoder to use for each set item.
`config`	`SetCodecConfig`<`NumberEncoder`> & `object`	Optional configuration specifying the size strategy.

Returns

FixedSizeEncoder<Set<TFrom>>

An Encoder<Set<TFrom>> for encoding sets of items.

Example

Encoding a set of u8 numbers.

const encoder = getSetEncoder(getU8Encoder());
const bytes = encoder.encode(new Set([1, 2, 3]));
// 0x03000000010203
//   |       └-- 3 items of 1 byte each.
//   └-- 4-byte prefix indicating 3 items.

See

getSetCodec

Call Signature

function getSetEncoder<TFrom>(
    item,
    config?,
): VariableSizeEncoder<Set<TFrom>>;

Returns an encoder for sets of items.

This encoder serializes Set<T> values by encoding each item using the provided item encoder. The number of items is stored as a prefix using a u32 codec by default.

For more details, see getSetCodec.

Type Parameters

Type Parameter	Description
`TFrom`	The type of the items in the set before encoding.

Parameters

Parameter	Type	Description
`item`	`Encoder`<`TFrom`>	The encoder to use for each set item.
`config?`	`SetCodecConfig`<`NumberEncoder`>	Optional configuration specifying the size strategy.

Returns

VariableSizeEncoder<Set<TFrom>>

An Encoder<Set<TFrom>> for encoding sets of items.

Example

Encoding a set of u8 numbers.

const encoder = getSetEncoder(getU8Encoder());
const bytes = encoder.encode(new Set([1, 2, 3]));
// 0x03000000010203
//   |       └-- 3 items of 1 byte each.
//   └-- 4-byte prefix indicating 3 items.

See

getSetCodec

getSetEncoder

On this page