Skip to content

Function: prepareString()

Call Signature

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

Prepares a string value for database storage with nullable support

Parameters

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

Returns

string | null

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

Throws

E_INVALID_PREPARED_VALUE when the value cannot be prepared

Call Signature

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

Prepares a string value for database storage with nullable support

Parameters

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

Returns

string

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

Throws

E_INVALID_PREPARED_VALUE when the value cannot be prepared