[Req] `—-@enum`

[FlashHit]

how do i do this?

---@class Realm
local Realm = {
	Realm_Client = 0,
	Realm_Server = 1,
	Realm_ClientAndServer = 2,
	Realm_None = 3,
	Realm_Pipeline = 4,
}

---@param p_Realm Realm?
function Test(p_Realm)
	p_Realm = Realm.Realm_Client
end

[well-in-that-case]

This is happening because you're assigning a parameter — that you defined as Realm type — to a field of Realm that's an integer. Not sure what the purpose of this is, but you can set the type of p_Realm as Realm|integer? to specify Realm or integer as the types. This may be what you want, since Realm_Client looks like a normal integer.

Take a look into the @alias, @cast, and @type tokens while you're at it too. These may help as well.

[FlashHit]

I could do this:

---@param p_Realm `Realm.Realm_Client` | `Realm.Realm_Server` | `Realm.Realm_ClientAndServer` | `Realm.Realm_None` | `Realm.Realm_Pipeline`

but thats not really a solution

[flrgh]

Enums are most easily annotated as @alias types. The OpenResty annotations in the repo have a good example:

https://github.com/sumneko/lua-language-server/blob/befc89c83b248aa4dbfd3bac8e744ca9969b1208/meta/3rd/OpenResty/library/ngx.lua#L39-L70

This makes it possible to write functions that take ngx.http.method as a param type:

https://github.com/sumneko/lua-language-server/blob/befc89c83b248aa4dbfd3bac8e744ca9969b1208/meta/3rd/OpenResty/library/ngx.lua#L2258-L2263

If that doesn't work you may need to explain a bit more about what you are trying to accomplish with this Test function.

[FlashHit]

would be nice if we could use sth like ---@enum Realm instead of ---@class Realm

[FlashHit]

well this doesn't look nice. it not optimal imo

[Nexela]

You can make that an alias and use the alias as the param type

…

On Wed, Jun 29, 2022, 4:43 PM FlashHit ***@***.***> wrote: [image: grafik] <https://user-images.githubusercontent.com/56718716/176540941-598e337b-1407-4c7e-b2d1-b68d53fa2f95.png> well this doesn't look nice. it not optimal imo — Reply to this email directly, view it on GitHub <#1255 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADKTFYG6IMPCTHZC2PDB5CDVRSYQ3ANCNFSM52G4G34Q> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[FlashHit]

You can make that an alias and use the alias as the param type

thats what I did

[sumneko]

---@enum Realm --> Equivalent to ---@alias Realm Realm.Realm_Client|Realm.Realm_Server|...
local Realm = {
	Realm_Client = 0, --> type: Realm.Realm_Client
	Realm_Server = 1, --> type: Realm.Realm_Server
	Realm_ClientAndServer = 2,
	Realm_None = 3,
	Realm_Pipeline = 4,
}

---@param p_Realm Realm?
function Test(p_Realm)
	p_Realm = Realm.Realm_Client
end

proposal of ---@enum

[FlashHit]

Yes please 👍

[FlashHit]

please add this to the next milestone :)