[feature] Populate all

[lookfirst]

I'd love an option to just load a top level entity and have it fully populated without having to do anything. Maybe just {populate: true}.

[B4nan]

Implemented in 3.0.0-alpha.15, as always, feel free to reopen.

[lookfirst]

sweet! totally makes my day. loading createdBy all the time sucks. ;-)

i know you have your own tests, but this also works:

https://github.com/lookfirst/mikro-example/blob/master/test/db/populate.spec.ts

[lookfirst]

One other idea, what about using an annotation for this, like @load. This way, I could just specify fields that I always wanted populated...

[B4nan]

Yeah, eager loading, that is also on the roadmap. Will probably do in as part of v3, as it should be pretty easy thanks to how populate support works now.

[lookfirst]

Oh interesting, populate string | true doesn't allow me to pass in a variable. it should be string | boolean i think.

[lookfirst]

Apologies, I don't see a way to reopen this issue.

[B4nan]

Its string[] | true, the array part is your problem I think. I could also support plain string.

[lookfirst]

No, it is a problem passing a boolean variable.

	async getRig(id: string, populate: boolean = true): Promise<Rig | null> {
		console.log('in get rig!');
		return this.getOrm().em.findOne(Rig, id, {populate});
	}

Error:(20, 10) TS2769: No overload matches this call.
  Overload 1 of 2, '(entityName: EntityName<Rig>, where: string | number | Record<string, any> | { toString?(): string; toHexString?(): string; } | Partial<Rig>, options?: FindOneOptions | undefined): Promise<...>', gave the following error.
    Argument of type '{ populate: boolean; }' is not assignable to parameter of type 'FindOneOptions'.
      Types of property 'populate' are incompatible.
        Type 'boolean' is not assignable to type 'true | string[] | undefined'.
  Overload 2 of 2, '(entityName: EntityName<Rig>, where: string | number | Record<string, any> | { toString?(): string; toHexString?(): string; } | Partial<Rig>, populate?: true | string[] | undefined, orderBy?: Record<...> | undefined): Promise<...>', gave the following error.
    Argument of type '{ populate: boolean; }' is not assignable to parameter of type 'true | string[] | undefined'.
      Object literal may only specify known properties, and 'populate' does not exist in type 'string[]'.

[B4nan]

Yeah well false is currently not valid value and it will probably cause an error. You could define your signature as:

async getRig(id: string, populate: string[] | true = true): Promise<Rig | null> { }

But I can support false as well, probably better to do so, as it can be used without TS at all so no type checks for literal types...

[lookfirst]

Only supporting one side of a boolean argument feels weird, but I think the JS argument is the most compelling.

[lookfirst]

Feels weird in that I don't know of a single other API that does that.

[B4nan]

Fixed in dev branch.