UnixTimestampType

Defined in: packages/ddd-mikro-orm/src/mapping/unix-timestamp.type.ts:47

MikroORM type that stores a Date as epoch milliseconds in a 64-bit bigint column.

null and undefined pass through in both directions. A value that has no valid time throws a TypeError rather than being stored or returned as NaN.

Extends

Type<Date | null | undefined, number | null | undefined>

Constructors

Constructor

new UnixTimestampType(): UnixTimestampType

Returns

UnixTimestampType

Inherited from

Type< Date | null | undefined, number | null | undefined >.constructor

Properties

meta?

optional meta?: EntityMetadata<any, EntityCtor<any>>

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:22

Inherited from

Type.meta

platform?

optional platform?: Platform

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:21

Inherited from

Type.platform

prop?

optional prop?: EntityProperty<any, any>

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:23

Inherited from

Type.prop

Accessors

name

Get Signature

get name(): string

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:50

Returns

string

Inherited from

Type.name

runtimeType

Get Signature

get runtimeType(): string

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:49

Returns

string

Inherited from

Type.runtimeType

Methods

compareAsType()

compareAsType(): string

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:44

Returns

string

Inherited from

Type.compareAsType

compareValues()?

optional compareValues(a, b): boolean

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:48

Allows to override the internal comparison logic.

Parameters

a

number | null | undefined

b

number | null | undefined

Returns

boolean

Inherited from

Type.compareValues

convertToDatabaseValue()

convertToDatabaseValue(value, _platform?, _context?): number | null | undefined

Defined in: packages/ddd-mikro-orm/src/mapping/unix-timestamp.type.ts:51

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

Parameters

value

Timestamp | null | undefined

_platform?

Platform

_context?

TransformContext

Returns

number | null | undefined

Overrides

Type.convertToDatabaseValue

convertToDatabaseValueSQL()?

optional convertToDatabaseValueSQL(key, platform): string

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:35

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

Parameters

key

string

platform

Platform

Returns

string

Inherited from

Type.convertToDatabaseValueSQL

convertToJSValue()

convertToJSValue(value, _platform?, _context?): Date | null | undefined

Defined in: packages/ddd-mikro-orm/src/mapping/unix-timestamp.type.ts:60

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

Parameters

value

Timestamp | null | undefined

_platform?

Platform

_context?

TransformContext

Returns

Date | null | undefined

Overrides

Type.convertToJSValue

convertToJSValueSQL()?

optional convertToJSValueSQL(key, platform): string

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:39

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

Parameters

key

string

platform

Platform

Returns

string

Inherited from

Type.convertToJSValueSQL

ensureComparable()

ensureComparable<T>(meta, prop): boolean

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:56

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

T extends object

Parameters

prop

EntityProperty<T>

Returns

boolean

Inherited from

Type.ensureComparable

fromJSON()?

optional fromJSON(value, platform): Date | null | undefined

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:72

Converts a value from its serialized JSON form back to its JS representation. Used when decoding cursor values. The input is what toJSON produced, after a JSON.parse round trip, and never an already restored JS value. Cursors are client supplied, so the value can be any JSON shape: validate it and throw for values the type cannot restore, and findByCursor surfaces the failure as a CursorError. Implementing this method also makes cursor encoding use toJSON. Without it, cursors carry the raw JS value, and decoding falls back to convertToJSValue, with type-based Date restoration for date-like columns.

Parameters

value

unknown

platform

Platform

Returns

Date | null | undefined

Inherited from

Type.fromJSON

getColumnType()

getColumnType(prop?, platform?): string

Defined in: packages/ddd-mikro-orm/src/mapping/unix-timestamp.type.ts:70

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

Parameters

prop?

EntityProperty = ...

platform?

Platform

Returns

string

Overrides

Type.getColumnType

getDefaultLength()?

optional getDefaultLength(platform): number

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:91

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.

Inherited from

Type.getDefaultLength

toJSON()

toJSON(value, platform): number | Date | null | undefined

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:61

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

Parameters

value

Date | null | undefined

platform

Platform

Returns

number | Date | null | undefined

Inherited from

Type.toJSON

getOrmType()

static getOrmType(cls): string | undefined

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:102

Internal

Returns the built-in type registry key if the given constructor is a branded ORM type (not a user subclass). Uses Symbol.for() so it works across CJS/ESM module graphs.

Parameters

cls

object

Returns

string | undefined

Inherited from

Type.getOrmType

getType()

static getType<JSType, DBType, TypeClass>(cls): InstanceType<TypeClass>

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:92

Type Parameters

JSType

JSType

DBType

DBType = JSType

TypeClass

TypeClass extends Constructor<Type<JSType, DBType>> = Constructor<Type<JSType, DBType>>

Parameters

cls

TypeClass

Returns

InstanceType<TypeClass>

Inherited from

Type.getType

isMappedType()

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

Defined in: node_modules/.pnpm/@mikro-orm+core@7.2.1/node_modules/@mikro-orm/core/types/Type.d.ts:96

Checks whether the argument is instance of Type.

Parameters

data

any

Returns

data is Type<any, any>

Inherited from

Type.isMappedType