BigIntType

This type will automatically convert string values returned from the database to native JS bigints (default) or numbers (safe only for values up to Number.MAX_SAFE_INTEGER), or strings, depending on the mode.

Hierarchy

• Type<string | bigint | number | null | undefined, string | null | undefined>
  • BigIntType

Index

Constructors

• constructor

Properties

• meta
• mode
• platform
• prop

Accessors

• name
• runtimeType

Methods

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

Constructors

constructor

• new BigIntType(mode?: string | number | bigint): BigIntType

• Overrides Type.constructor

  Parameters

  • optionalmode: string | number | bigint

  Returns BigIntType

Properties

optionalinheritedmeta

meta?: EntityMetadata<any>

Inherited from Type.meta

publicoptionalmode

mode?: string | number | bigint

optionalinheritedplatform

platform?: Platform

Inherited from Type.platform

optionalinheritedprop

prop?: EntityProperty<any, any>

Inherited from Type.prop

Accessors

inheritedname

• get name(): string

• Inherited from Type.name

  Returns string

inheritedruntimeType

• get runtimeType(): string

• Inherited from Type.runtimeType

  Returns string

Methods

compareAsType

• compareAsType(): string

• Overrides Type.compareAsType

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

  ---

  Returns string

optionalinheritedcompareValues

• compareValues(a: undefined | null | string, b: undefined | null | string): boolean

• Inherited from Type.compareValues

  Allows to override the internal comparison logic.

  ---

  Parameters

  • a: undefined | null | string

  • b: undefined | null | string

  Returns boolean

convertToDatabaseValue

• convertToDatabaseValue(value: undefined | null | string | bigint): undefined | null | string

• Overrides Type.convertToDatabaseValue

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

  ---

  Parameters

  • value: undefined | null | string | bigint

  Returns undefined | null | string

optionalinheritedconvertToDatabaseValueSQL

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

• Inherited from Type.convertToDatabaseValueSQL

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

  ---

  Parameters

  • key: string

  • platform: Platform

  Returns string

convertToJSValue

• convertToJSValue(value: undefined | null | string | bigint): undefined | null | string | number | bigint

• Overrides Type.convertToJSValue

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

  ---

  Parameters

  • value: undefined | null | string | bigint

  Returns undefined | null | string | number | bigint

optionalinheritedconvertToJSValueSQL

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

• Inherited from Type.convertToJSValueSQL

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

  ---

  Parameters

  • key: string

  • platform: Platform

  Returns string

inheritedensureComparable

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

• Inherited from Type.ensureComparable

  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.

  ---

  Parameters

  • meta: EntityMetadata<T>

  • prop: EntityProperty<T, any>

  Returns boolean

getColumnType

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

• Overrides Type.getColumnType

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

  ---

  Parameters

  • prop: EntityProperty<any, any>

  • platform: Platform

  Returns string

optionalinheritedgetDefaultLength

• getDefaultLength(platform: Platform): number

• Inherited from Type.getDefaultLength

  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: undefined | null | string | bigint): undefined | null | string | bigint

• Overrides Type.toJSON

  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 | bigint

  Returns undefined | null | string | bigint

staticinheritedgetType

• getType(cls: TypeClass): InstanceType<TypeClass>

• Inherited from Type.getType

  Parameters

  • cls: TypeClass

  Returns InstanceType<TypeClass>

staticinheritedisMappedType

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

• Inherited from Type.isMappedType

  Checks whether the argument is instance of Type.

  ---

  Parameters

  • data: any

  Returns data is Type<any, any>