abstractType <JSType, DBType>

Hierarchy

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

Index

Constructors

• constructor

Properties

• meta
• platform
• prop

Methods

• [custom]
• compareAsType
• convertToDatabaseValue
• convertToDatabaseValueSQL
• convertToJSValue
• convertToJSValueSQL
• getColumnType
• 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>

Methods

[custom]

• [custom](depth: number): string

• Parameters

  • depth: number

  Returns string

compareAsType

• compareAsType(): string

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

  ---

  Returns string

convertToDatabaseValue

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

• 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

• 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: JSType | DBType, platform: Platform): JSType

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

  ---

  Parameters

  • value: JSType | 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

getColumnType

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

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

  ---

  Parameters

  • prop: EntityProperty<any>

  • platform: Platform

  Returns string

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>(cls: Constructor<Type<JSType, DBType>>): Type<JSType, DBType>

• Type parameters

  • JSType
  • DBType = JSType

  Parameters

  • cls: Constructor<Type<JSType, DBType>>

  Returns Type<JSType, DBType>

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>