Skip to main content
Version: Next

EnumType

Hierarchy

  • Type<string | null | undefined>
    • EnumType

Index

Constructors

constructor

  • Returns EnumType

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: undefined | null | string, b: undefined | null | string): boolean
  • Allows to override the internal comparison logic.


    Parameters

    • a: undefined | null | string
    • b: undefined | null | string

    Returns boolean

convertToDatabaseValue

  • convertToDatabaseValue(value: undefined | null | string, platform: Platform, context?: TransformContext): undefined | null | string
  • Converts a value from its JS representation to its database representation of this type.


    Parameters

    Returns undefined | null | string

optionalconvertToDatabaseValueSQL

  • convertToDatabaseValueSQL(key: string, platform: Platform): string
  • Converts a value from its JS representation to its database representation of this type.


    Parameters

    Returns string

convertToJSValue

  • convertToJSValue(value: undefined | null | string, platform: Platform): undefined | null | string
  • Converts a value from its database representation to its JS representation of this type.


    Parameters

    • value: undefined | null | string
    • platform: Platform

    Returns undefined | null | string

optionalconvertToJSValueSQL

  • convertToJSValueSQL(key: string, platform: Platform): string
  • Modifies the SQL expression (identifier, parameter) to convert to a JS value.


    Parameters

    Returns string

ensureComparable

  • ensureComparable(): 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.


    Returns boolean

getColumnType

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


    Parameters

    Returns string

toJSON

  • toJSON(value: undefined | null | string, platform: Platform): undefined | null | string
  • Converts a value from its JS representation to its serialized JSON form of this type. By default uses the runtime value.


    Parameters

    • value: undefined | null | string
    • platform: Platform

    Returns undefined | null | string

staticgetType

  • Type parameters

    • JSType
    • DBType = JSType

    Parameters

    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>