Skip to main content
Version: 5.9

FullTextType

Hierarchy

  • Type<string, string>
    • FullTextType

Index

Constructors

Properties

Methods

Constructors

constructor

  • new FullTextType(): FullTextType

  • Returns FullTextType

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: string, platform: Platform, context?: boolean | TransformContext): string

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

    Parameters

    • value: string
    • platform: Platform
    • optionalcontext: boolean | TransformContext

    Returns string

convertToDatabaseValueSQL

  • convertToDatabaseValueSQL(key: string): string

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

    Parameters

    • key: string

    Returns string

convertToJSValue

  • convertToJSValue(value: string, platform: Platform): string

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

    Parameters

    • value: string
    • platform: Platform

    Returns string

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>): 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>

    Returns boolean

getColumnType

  • getColumnType(): string

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

    Returns string

toJSON

  • toJSON(value: string, platform: Platform): string

  • Converts a value from its JS representation to its serialized JSON form of this type. By default uses the runtime value.

    Parameters

    • value: string
    • platform: Platform

    Returns string

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>

staticisCustomType

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

  • Checks whether the argument is instance of custom Type class provided by the user.

    Parameters

    • data: any

    Returns data is Type<any, any>

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>

Page Options