Skip to main content
Version: Next

Class: BigIntType

core.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

Constructors#

constructor#

new BigIntType()

Inherited from#

Type.constructor

Methods#

compareAsType#

compareAsType(): string

Returns#

string

Overrides#

Type.compareAsType

Defined in#

packages/core/src/types/BigIntType.ts:30


convertToDatabaseValue#

convertToDatabaseValue(value): undefined | null | string

Parameters#

NameType
valueundefined | null | string | bigint

Returns#

undefined | null | string

Overrides#

Type.convertToDatabaseValue

Defined in#

packages/core/src/types/BigIntType.ts:10


convertToDatabaseValueSQL#

Optional convertToDatabaseValueSQL(key, platform): string

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

Parameters#

NameType
keystring
platformPlatform

Returns#

string

Inherited from#

Type.convertToDatabaseValueSQL

Defined in#

packages/core/src/types/Type.ts:25


convertToJSValue#

convertToJSValue(value): undefined | null | string

Parameters#

NameType
valueundefined | null | string | bigint

Returns#

undefined | null | string

Overrides#

Type.convertToJSValue

Defined in#

packages/core/src/types/BigIntType.ts:18


convertToJSValueSQL#

Optional convertToJSValueSQL(key, platform): string

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

Parameters#

NameType
keystring
platformPlatform

Returns#

string

Inherited from#

Type.convertToJSValueSQL

Defined in#

packages/core/src/types/Type.ts:30


getColumnType#

getColumnType(prop, platform): string

Parameters#

NameType
propEntityProperty<any>
platformPlatform

Returns#

string

Overrides#

Type.getColumnType

Defined in#

packages/core/src/types/BigIntType.ts:26


toJSON#

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

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

Parameters#

NameType
valueundefined | null | string | bigint
platformPlatform

Returns#

undefined | null | string | bigint

Inherited from#

Type.toJSON

Defined in#

packages/core/src/types/Type.ts:44


getType#

Static getType<JSType, DBType>(cls): Type<JSType, DBType>

Type parameters#

NameType
JSTypeJSType
DBTypeDBType = JSType

Parameters#

NameType
clsConstructor<Type<JSType, DBType>>

Returns#

Type<JSType, DBType>

Inherited from#

Type.getType

Defined in#

packages/core/src/types/Type.ts:55