LuaLS / LuaLS/lua-language-server
Support discriminated unions / type narrowing
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Lua
- Star
- 4.4k
- Fork
- 442
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với ví dụ ActionType của issue và đọc tài liệu TypeScript được liên kết về narrowing kiểu để xác định hành vi mong đợi. Được coi là hoàn thành khi các giá trị union chỉ hiển thị các thuộc tính dùng chung trước khi kiểm tra kiểu, còn các kiểm tra trên trường type hiển thị các thuộc tính của biến thể action tương ứng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- lua, typescript
- Lĩnh vực
- devtools
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 25/100