Repository navigation
How to do multiple named return values? #3374
Description
https://luals.github.io/wiki/annotations/#return
I tried this
---@return boolean, string ok result comment
local function parse(input)
local ok = true
local result = "foo"
return ok, result
end
---@return boolean, string ok, result comment
local function parse2(input)
local ok = true
local result = "foo"
return ok, result
end
Activity
carsakiller commentedon Mar 10, 2026
You should use a
@returnper return value:ChillerDragon commentedon Mar 11, 2026
Oh I somehow thought that was for function overloading. Where it could return either one or the other.
Will look into it 👀
ChillerDragon commentedon Mar 11, 2026
Maybe I'll send a pr to the wiki with one more example for that. Because I feel like it's missing in the return section.
Better way to annotate multiple return values
add: multiple return values example
add: multiple return values example (LuaLS#109)