Skip to content

Function: consumeString() ​

Call Signature ​

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

Consumes a string 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 ​

string | null

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

Throws ​

E_INVALID_CONSUMED_VALUE when the value cannot be consumed

Call Signature ​

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

Consumes a string 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 ​

string

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

Throws ​

E_INVALID_CONSUMED_VALUE when the value cannot be consumed