[v5] Missing relationship intellisense inside model methods

[rrmesquita]

What is the proper way to fetch all records for a given relationship from inside the model?

Even though it actually works as expected, the following code:

public async getRoles () {
  return await this.related('roles').query()
}

Will show the following intellisense error on roles string:

Argument of type 'string' is not assignable to parameter of type 'ExtractModelRelations<this>'.ts(2345)

It's a bug or I'm missing something? 🤔

UPDATE: Here's what expected when I hit ctrl + space:

[Reptiluka]

I don't know in which file you are (the model or a controller), but I think you can't simply use "this" as the wanted keyword User.
So I think the intellissense is right, use User instead of this 🙂

[rrmesquita]

Yeah, totally forgot to mention I'm in the User model class. But if you think that this represents the model instance (just like new User()), doesn't it make sense to grab its relationships as well?

[Reptiluka]

I think I already tried in the past to do something like you try, to "preload" for all model instance, but finally I just use the model with the relationship tag, and in the controller do the others things.

If you found a solution write it here, it can be useful haha

[rrmesquita]

@thetutlage Any thoughts on that? I think the ExtractModelRelations type it's expecting an already instantiated model, maybe?

[thetutlage]

The issue is with Typescript. I raised it with them a while back, but its not fixed till now. microsoft/TypeScript#37778

[eliferd]

Apparently, it is now finally fixed on TypeScript 5.1

[WeyIin]

Inside model:

  @belongsTo(() => Roles)
  public roles: BelongsTo<typeof Roles>

public getRoles() {
return this.roles
}

roles relationship has to be preloaded.

This is how I use it and unsure if it's right or wrong approach

[rrmesquita]

I've found a simple and clever workaround for this issue on this comment.

Basically, aliasing this does the trick.

public async getRoles () {
  const user: User = this

  return await user.related('roles').query()
}

[motvicka]

Or just

public async getRoles () {
  return await (user as User).related('roles').query()
}

[rodrigorz]

I think i've found the correct way here.

... we can add a this parameter to method definitions to statically enforce that the method is called correctly:

class User {
  // ...

  public async getRoles (this: User, status: string) {
    return await this.related('roles').query().where('status', status).exec(); // now works
  }
}

const roles = await user.getRoles('active'); // this parameter will not be needed when call the method, just the other params

[rrmesquita]

"This" is a really cool feature from TypeScript, thank you for sharing @rodrigorz!

[inghggw]

thanks!!