BigIntType

This type will automatically convert string values returned from the database to native JS bigints.

Hierarchy

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

Index

Constructors

• constructor

Methods

• compareAsType
• convertToDatabaseValue
• convertToDatabaseValueSQL
• convertToJSValue
• convertToJSValueSQL
• getColumnType
• toJSON
• getType
• isMappedType

Constructors

constructor

• new BigIntType(): BigIntType

• Inherited from Type.constructor

  Returns BigIntType

Methods

compareAsType

• compareAsType(): string

• Overrides Type.compareAsType

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

optionalconvertToDatabaseValueSQL

• 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

• 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

optionalconvertToJSValueSQL

• 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

getColumnType

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

• Overrides Type.getColumnType

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

  ---

  Parameters

  • prop: EntityProperty<any>

  • platform: Platform

  Returns string

toJSON

• toJSON(value: undefined | null | string | bigint, platform: Platform): undefined | null | string | bigint

• Inherited from 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

  • platform: Platform

  Returns undefined | null | string | bigint

staticgetType

• getType<JSType, DBType>(cls: Constructor<Type<JSType, DBType>>): Type<JSType, DBType>

• Inherited from Type.getType

  Type parameters

  • JSType
  • DBType = JSType

  Parameters

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

  Returns Type<JSType, DBType>

staticisMappedType

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