Annotations Help

[kylechui]

A bit of a strange question, but is there a way to specify a table of strings that necessarily contains a certain key? For example, we may have table<string, string> or { KEY_NAME: string }. Is there a way to combine these two so I have completion for KEY_NAME, but also enforce that the rest of the table only contains strings as keys?

[carsakiller]

Hm, I thought something like this would work:

---@alias Headers
---| 'Authorization'
---| string

---@type table<Headers, string>
local headers = {}

Or like this:

---@alias Headers
---| 'Authorization'

---@type table<Headers | string, string>
local headers = {}

But neither seem to provide type checking nor completion for the defined headers. This should probably me made an issue instead.

In fact, even this doesn't warn me:

---@type table<number, string>
local headers = {
    str = "hello"
}

[Frityet]

A bit of a strange question, but is there a way to specify a table of strings that necessarily contains a certain key? For example, we may have table<string, string> or { KEY_NAME: string }. Is there a way to combine these two so I have completion for KEY_NAME, but also enforce that the rest of the table only contains strings as keys?

---@type { [string] : string, ["KEY_NAME"]: string }
local t = {}

[kylechui]

Upon an initial test, this seems to just ignore the ["KEY_NAME"]: string part of the type annotation, i.e. if I change it to

---@type { [string] : integer, ["KEY_NAME"]: string }
local t = {
    hello = 5,
}

then the above does not throw any errors, and I get no completion for KEY_NAME.