abstractType <JSType, DBType>

Hierarchy

• Type
  • DateType
  • TimeType
  • DateTimeType
  • BigIntType
  • Uint8ArrayType
  • ArrayType
  • EnumType
  • JsonType
  • IntegerType
  • SmallIntType
  • TinyIntType
  • FloatType
  • DoubleType
  • BooleanType
  • DecimalType
  • StringType
  • UuidType
  • TextType
  • IntervalType
  • FullTextType
  • UnicodeStringType

Index

Constructors

• constructor

Properties

• meta
• platform
• prop

Accessors

• name
• runtimeType

Methods

• compareAsType
• compareValues
• convertToDatabaseValue
• convertToDatabaseValueSQL
• convertToJSValue
• convertToJSValueSQL
• ensureComparable
• getColumnType
• getDefaultLength
• toJSON
• getType
• isMappedType

Constructors

constructor

• new Type<JSType, DBType>(): Type<JSType, DBType>

• Type parameters

  • JSType = string
  • DBType = JSType

  Returns Type<JSType, DBType>

Properties

optionalmeta

meta?: EntityMetadata<any>

optionalplatform

platform?: Platform

optionalprop

prop?: EntityProperty<any, any>

Accessors

name

• get name(): string

• Returns string

runtimeType

• get runtimeType(): string

• Returns string

Methods

compareAsType

• compareAsType(): string

• How should the raw database values be compared? Used in EntityComparator. Possible values: string | number | bigint | boolean | date | any | buffer | array

  ---

  Returns string

optionalcompareValues

• compareValues(a: DBType, b: DBType): boolean

• Allows to override the internal comparison logic.

  ---

  Parameters

  • a: DBType

  • b: DBType

  Returns boolean

convertToDatabaseValue

• convertToDatabaseValue(value: JSType, platform: Platform, context?: TransformContext): DBType

• Converts a value from its JS representation to its database representation of this type.

  ---

  Parameters

  • value: JSType

  • platform: Platform

  • optionalcontext: TransformContext

  Returns DBType

optionalconvertToDatabaseValueSQL

• convertToDatabaseValueSQL(key: string, platform: Platform): string

• Converts a value from its JS representation to its database representation of this type.

  ---

  Parameters

  • key: string

  • platform: Platform

  Returns string

convertToJSValue

• convertToJSValue(value: DBType, platform: Platform): JSType

• Converts a value from its database representation to its JS representation of this type.

  ---

  Parameters

  • value: DBType

  • platform: Platform

  Returns JSType

optionalconvertToJSValueSQL

• convertToJSValueSQL(key: string, platform: Platform): string

• Modifies the SQL expression (identifier, parameter) to convert to a JS value.

  ---

  Parameters

  • key: string

  • platform: Platform

  Returns string

ensureComparable

• ensureComparable<T>(meta: EntityMetadata<T>, prop: EntityProperty<T, any>): boolean

• When a value is hydrated, we convert it back to the database value to ensure comparability, as often the raw database response is not the same as the convertToDatabaseValue result. This allows to disable the additional conversion in case you know it is not needed.

  ---

  Type parameters

  • T: object

  Parameters

  • meta: EntityMetadata<T>

  • prop: EntityProperty<T, any>

  Returns boolean

getColumnType

• getColumnType(prop: EntityProperty<any, any>, platform: Platform): string

• Gets the SQL declaration snippet for a field of this type.

  ---

  Parameters

  • prop: EntityProperty<any, any>

  • platform: Platform

  Returns string

optionalgetDefaultLength

• getDefaultLength(platform: Platform): number

• Get the default length for values of this type

  When doing schema generation, if neither "length" nor "columnType" option is provided, the length will be defaulted to this value.

  When doing entity generation, if the type is recognized to this type, and the inferred length is this value, the length option will be omitted in the output. If this method is not defined, length is always outputted based on what is in the database metadata.

  ---

  Parameters

  • platform: Platform

    The platform the default will be used for.

  Returns number

  The default value for the given platform.

toJSON

• toJSON(value: JSType, platform: Platform): JSType | DBType

• 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

• getType<JSType, DBType, TypeClass>(cls: TypeClass): InstanceType<TypeClass>

• Type parameters

  • JSType
  • DBType = JSType
  • TypeClass: Constructor<Type<JSType, DBType>> = Constructor<Type<JSType, DBType>>

  Parameters

  • cls: TypeClass

  Returns InstanceType<TypeClass>

staticisMappedType

• isMappedType(data: any): data is Type<any, any>

• Checks whether the argument is instance of Type.

  ---

  Parameters

  • data: any

  Returns data is Type<any, any>