ValueConverter

Interface for converting values between different formats, such as in-memory objects, database storage, JSON data transfer objects (DTOs), and HTML input elements.

fromJson

Converts a value from a JSON DTO to the valueType. This method is typically used when receiving data from a REST API call or deserializing a JSON payload.

returns:

The converted value.

example:

fromJson: val => new Date(val)

Arguments:

• val - The value to convert.

toJson

Converts a value of valueType to a JSON DTO. This method is typically used when sending data to a REST API or serializing an object to a JSON payload.

returns:

The converted value.

example:

toJson: val => val?.toISOString()

Arguments:

• val - The value to convert.

fromDb

Converts a value from the database format to the valueType.

returns:

The converted value.

example:

fromDb: val => new Date(val)

Arguments:

• val - The value to convert.

toDb

Converts a value of valueType to the database format.

returns:

The converted value.

example:

toDb: val => val?.toISOString()

Arguments:

• val - The value to convert.

toDbSql

• toDbSql

Arguments:

• val

toInput

Converts a value of valueType to a string suitable for an HTML input element.

returns:

The converted value as a string.

example:

toInput: (val, inputType) => val?.toISOString().substring(0, 10)

Arguments:

• val - The value to convert.
• inputType - The type of the input element (optional).

fromInput

Converts a string from an HTML input element to the valueType.

returns:

The converted value.

example:

fromInput: (val, inputType) => new Date(val)

Arguments:

• val - The value to convert.
• inputType - The type of the input element (optional).

displayValue

Returns a displayable string representation of a value of valueType.

returns:

The displayable string.

example:

displayValue: val => val?.toLocaleDateString()

Arguments:

• val - The value to convert.

fieldTypeInDb

Specifies the storage type used in the database for this field. This can be used to explicitly define the data type and precision of the field in the database.

example:

// Define a field with a specific decimal precision in the database
@Fields.number({
  valueConverter: {
    fieldTypeInDb: 'decimal(18,8)'
  }
})
price=0;

inputType

Specifies the type of HTML input element suitable for values of valueType.

example:

inputType = 'date';