abstractType <JSType, DBType>
Hierarchy
Index
Constructors
constructor
Type parameters
- JSType = string
- DBType = JSType
Returns Type<JSType, DBType>
Properties
optionalmeta
optionalplatform
optionalprop
Methods
[custom]
Parameters
depth: number
Returns string
compareAsType
Returns string
convertToDatabaseValue
Converts a value from its JS representation to its database representation of this type.
Parameters
value: JSType | DBType
platform: Platform
optionalcontext: boolean | TransformContext
Returns DBType
optionalconvertToDatabaseValueSQL
Converts a value from its JS representation to its database representation of this type.
Parameters
key: string
platform: Platform
Returns string
convertToJSValue
Converts a value from its database representation to its JS representation of this type.
Parameters
value: JSType | DBType
platform: Platform
Returns JSType
optionalconvertToJSValueSQL
Modifies the SQL expression (identifier, parameter) to convert to a JS value.
Parameters
key: string
platform: Platform
Returns string
getColumnType
Gets the SQL declaration snippet for a field of this type.
Parameters
prop: EntityProperty<any>
platform: Platform
Returns string
toJSON
Converts a value from its JS representation to its serialized JSON form of this type. By default uses the runtime value.
Parameters
value: JSType
platform: Platform
Returns JSType | DBType
staticgetType
Type parameters
- JSType
- DBType = JSType
Parameters
cls: Constructor<Type<JSType, DBType>>
Returns Type<JSType, DBType>
staticisMappedType
Checks whether the argument is instance of
Type
.Parameters
data: any
Returns data is Type<any, any>
How should the raw database values be compared? Used in
EntityComparator
. Possible values: string | number | boolean | date | any | buffer | array