rootEntityProperties

rootEntityProperties(columns?): object

Defined in: packages/ddd-mikro-orm/src/mapping/root-entity.properties.ts:36

Identity and timestamp columns shared by every RootEntity schema, mapped through the entity’s private hydration setters (accessor: true). Timestamps are stored as epoch milliseconds through UnixTimestampType. Returns fresh property definitions for each schema.

Parameters

columns?

RootEntityColumns = {}

Column names that differ from the defaults.

Returns

object

createdAt

readonly createdAt: object

createdAt.accessor

readonly accessor: true = true

createdAt.fieldName

readonly fieldName: string

createdAt.type

readonly type: typeof UnixTimestampType = UnixTimestampType

id

readonly id: object

id.accessor

readonly accessor: true = true

id.fieldName

readonly fieldName: string

id.primary

readonly primary: true = true

id.type

readonly type: "string" = 'string'

updatedAt

readonly updatedAt: object

updatedAt.accessor

readonly accessor: true = true

updatedAt.fieldName

readonly fieldName: string

updatedAt.type

readonly type: typeof UnixTimestampType = UnixTimestampType

Example

export const UserSchema = new EntitySchema<User, AggregateRoot>({
  class: User as any,
  tableName: 'users',
  properties: {
    ...rootEntityProperties(),
    version: versionProperty(),
    email: { type: 'string', unique: true },
  },
});