LuaLS / LuaLS/lua-language-server
Support discriminated unions / type narrowing
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Lua
- Estrellas
- 4.4k
- Forks
- 442
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
In TypeScript this is supported by "narrowing"
Consider this example:
---@alias ChatAction { type: '"chat"', targetName: string, msg: string }
---@alias NotifyAction { type: '"notify"', msg: string, colour: number }
---@alias ActionType ChatAction | NotifyAction
---@param action ActionType
local function example(action)
-- action is any action (properties 'type', 'msg')
if (action.type == 'chat') then
-- action is ChatAction (properties 'type', 'msg', 'targetName')
end
if (action.type == 'notify') then
-- action is NotifyAction (properties 'type', 'msg', 'colour')
end
end
For a union type such as 'ActionType' in the example, the only defined properties should be those common to all types. After narrowing (through some sort of type check, in this case a type field) the additional properties in the narrowed subset are also available.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el ejemplo de ActionType del issue y lee la documentación enlazada de TypeScript sobre el estrechamiento de tipos para definir el comportamiento esperado. Se considera terminado cuando los valores de una unión exponen solo las propiedades compartidas antes de una comprobación de tipos, mientras que las comprobaciones del campo type exponen las propiedades de la variante de acción correspondiente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- lua, typescript
- Área
- devtools
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100