getBooleanEncoder

Call Signature

function getBooleanEncoder(): FixedSizeEncoder<boolean, 1>;

Returns an encoder for boolean values.

This encoder converts true into 1 and false into 0. The size option allows customizing the number codec used for storage.

For more details, see getBooleanCodec.

A FixedSizeEncoder<boolean, N> where N is the size of the number codec.

Encoding booleans.

const encoder = getBooleanEncoder();
 
encoder.encode(false); // 0x00
encoder.encode(true);  // 0x01

function getBooleanEncoder<TSize>(
    config,
): FixedSizeEncoder<boolean, TSize>;

Returns an encoder for boolean values.

This encoder converts true into 1 and false into 0. The size option allows customizing the number codec used for storage.

For more details, see getBooleanCodec.

Type Parameter
`TSize` extends `number`

Parameter	Type	Description
`config`	`BooleanCodecConfig`<`NumberEncoder`> & `object`	Configuration options for encoding booleans.

FixedSizeEncoder<boolean, TSize>

A FixedSizeEncoder<boolean, N> where N is the size of the number codec.

Encoding booleans.

const encoder = getBooleanEncoder();
 
encoder.encode(false); // 0x00
encoder.encode(true);  // 0x01

function getBooleanEncoder(config): VariableSizeEncoder<boolean>;

Returns an encoder for boolean values.

This encoder converts true into 1 and false into 0. The size option allows customizing the number codec used for storage.

For more details, see getBooleanCodec.

Parameter	Type	Description
`config`	`BooleanCodecConfig`<`NumberEncoder`>	Configuration options for encoding booleans.

A FixedSizeEncoder<boolean, N> where N is the size of the number codec.

Encoding booleans.

const encoder = getBooleanEncoder();
 
encoder.encode(false); // 0x00
encoder.encode(true);  // 0x01