getBooleanDecoder

Call Signature

function getBooleanDecoder(): FixedSizeDecoder<boolean, 1>;

Returns a decoder for boolean values.

This decoder reads a number and interprets 1 as true and 0 as false. The size option allows customizing the number codec used for storage.

For more details, see getBooleanCodec.

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

Decoding booleans.

const decoder = getBooleanDecoder();
 
decoder.decode(new Uint8Array([0x00])); // false
decoder.decode(new Uint8Array([0x01])); // true

function getBooleanDecoder<TSize>(
    config,
): FixedSizeDecoder<boolean, TSize>;

Returns a decoder for boolean values.

This decoder reads a number and interprets 1 as true and 0 as false. 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`<`NumberDecoder`> & `object`	Configuration options for decoding booleans.

FixedSizeDecoder<boolean, TSize>

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

Decoding booleans.

const decoder = getBooleanDecoder();
 
decoder.decode(new Uint8Array([0x00])); // false
decoder.decode(new Uint8Array([0x01])); // true

function getBooleanDecoder(config): VariableSizeDecoder<boolean>;

Returns a decoder for boolean values.

This decoder reads a number and interprets 1 as true and 0 as false. The size option allows customizing the number codec used for storage.

For more details, see getBooleanCodec.

Parameter	Type	Description
`config`	`BooleanCodecConfig`<`NumberDecoder`>	Configuration options for decoding booleans.

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

Decoding booleans.

const decoder = getBooleanDecoder();
 
decoder.decode(new Uint8Array([0x00])); // false
decoder.decode(new Uint8Array([0x01])); // true