Skip to content

Function: prepareObject() ​

Call Signature ​

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

Prepares an object 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 ​

| LucidPlainObject | null

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

Throws ​

E_INVALID_PREPARED_VALUE when the value cannot be prepared

Call Signature ​

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

Prepares an object 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 ​

LucidPlainObject

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

Throws ​

E_INVALID_PREPARED_VALUE when the value cannot be prepared