Skip to content

Function: consumeBoolean() ​

Call Signature ​

ts
function consumeBoolean(
  key: string,
  value: unknown,
  nullable: true,
): boolean | null;

Consumes a boolean value from database results with nullable support

Parameters ​

ParameterTypeDescription
keystringThe field name for error reporting
valueunknownThe value to consume
nullabletrueWhether the field can be null

Returns ​

boolean | null

The consumed boolean value or null if nullable and value is null

Throws ​

E_INVALID_CONSUMED_VALUE when the value cannot be consumed

Call Signature ​

ts
function consumeBoolean(key: string, value: unknown, nullable?: false): boolean;

Consumes a boolean value from database results with nullable support

Parameters ​

ParameterTypeDescription
keystringThe field name for error reporting
valueunknownThe value to consume
nullable?falseWhether the field can be null

Returns ​

boolean

The consumed boolean value or null if nullable and value is null

Throws ​

E_INVALID_CONSUMED_VALUE when the value cannot be consumed