Skip to main content
Version: 5.2

EnumArrayType <T>

Hierarchy

Index

Constructors

constructor

  • new EnumArrayType<T>(owner: string, items?: T[], hydrate?: (i: string) => T): EnumArrayType<T>
  • Type parameters

    • T: string | number = string

    Parameters

    • owner: string
    • optionalitems: T[]
    • hydrate: (i: string) => T = ...

    Returns EnumArrayType<T>

Methods

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: null | T[], platform: Platform, fromQuery?: boolean): null | string
  • Converts a value from its JS representation to its database representation of this type.


    Parameters

    • value: null | T[]
    • platform: Platform
    • optionalfromQuery: boolean

    Returns 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: null | string | T[], platform: Platform): null | T[]
  • Converts a value from its database representation to its JS representation of this type.


    Parameters

    • value: null | string | T[]
    • platform: Platform

    Returns null | T[]

optionalconvertToJSValueSQL

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


    Parameters

    Returns string

getColumnType

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


    Parameters

    Returns string

toJSON

  • toJSON(value: T[]): T[]
  • Converts a value from its JS representation to its serialized JSON form of this type. By default uses the runtime value.


    Parameters

    • value: T[]

    Returns T[]

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>