Issue in creating a class instance using mikro-orm and typescript and inserting into postgresql database

Question

I'm trying to code along to this React GraphQL TypeScript tutorial

The project uses MikroOrm to communicate with a PostgreSQL database.

Goal: To create an instance of post and insert it into the database.

Currently I'm at minute 19.53 and I'm stuck with the following error which does not appear in the video, I'm not sure why.

Post.ts file:

@Entity() //correspond to database table.
export class Post {
    @PrimaryKey()
    id!: number;

    @Property({ type: 'date'}) //denote database column, without it its just a class attribute
    createdAt = new Date();

    @Property({ type: 'date', onUpdate: () => new Date() })
    updatedAt = new Date();

    @Property({type: 'text'})
    title!: string;
}

Index.ts file:

const main = async () => {
    const orm = await MikroORM.init(microConfig);
    const post = orm.em.create(Post, {title: "my first post" }); //create instance of post
    await orm.em.persistAndFlush(post); //insert into database
}

The line in Index.ts is throwing me an error:

const post = orm.em.create(Post, {title: "my first post" });

Argument of type '{ title: string; }' is not assignable to parameter of type 'RequiredEntityData<Post>'.
  Type '{ title: string; }' is missing the following properties from type '{ createdAt: EntityDataItem<Date>; updatedAt: EntityDataItem<Date>; title: EntityDataItem<string>;

Martin Adámek · Accepted Answer · 2022-10-24T10:48:12.570

You need to mark properties that have initializer via OptionalProps symbol to make them optional for the em.create() method. Also instead of explicit type option you can just specify the type explicitly (inference won't work with reflect-metadata).

https://mikro-orm.io/docs/property-validation#properties-with-default-value

Here is an entity definition that should work fine:

@Entity()
export class Post {
    [OptionalProps]?: 'createdAt' | 'updatedAt';

    @PrimaryKey()
    id!: number;

    @Property()
    createdAt: Date = new Date();

    @Property({ onUpdate: () => new Date() })
    updatedAt: Date = new Date();

    @Property({ type: 'text' })
    title!: string;
}

score 0 · Answer 2 · edited May 29 '22 at 10:20

I was just stumbled this error, and this is how I solve it. That error basically saying that you need to set updatedAt and createdAt on your create args. So here the entity should be:

import { Entity, PrimaryKey, Property } from "@mikro-orm/core";

@Entity()
export class Post {
  @PrimaryKey()
  id!: number;

  @Property()
  createdAt?: Date = new Date();

  @Property({ onUpdate: () => new Date() })
  updatedAt?: Date = new Date();

  @Property()
  title!: string;
}

You need to add "?" after createdAt and updatedAt so they recognized as optional properties.

Issue in creating a class instance using mikro-orm and typescript and inserting into postgresql database

2 Answers2