Combinations of return values?

[ThePython10110]

I have a function that will always return either false and an error message or true and an array of results. Currently, I'm doing this:

---@return boolean success
---@return string|vector.Vector[] results_or_error

When I actually call the function, I'm only checking the success boolean and not explicitly type checking results_or_error. If success is false, it treats results_or_error as a string, and when success is true, results_or_error is treated as a table. Unfortunately, the diagnostics don't know that...

Cannot assign `string|vector.Vector[]` to parameter `vector.Vector[]`.
- `string` cannot match `vector.Vector[]`
- Type `string` cannot match `vector.Vector[]`

So... the point is, is there any way for the type checker to figure out what the other return values' types are if one is known? Something like this?

---(@return false success
---@return string results_or_error)
---(@return true success
---@return vector.Vector[] results_or_error)

[Frityet]

the idomatic lua way, and how LuaLS is optimal for is by doing

---@return vector.Vector[]? results, string? error
local function some_func() end

Where you can then do

local ok, err = some_func()

or

local res = assert(some_func())