LuaLS / LuaLS/lua-language-server
How do I document a generic class (JS Promises)
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ả
Hello everyone! First of all, thank you for the amazing work on this server. It's really great and extremelly fast to use!
I've a question about how can I use the type system to properly type a Promise-like table that I'm creating. Right now I need to type this piece of code:
local Promise = require ".../promise"
Promise:new(function(resolve, reject)
-- do some async stuff...
if some_async_true_status then
resolve(some_async_result)
else
reject(some_async_error)
end
end):next(function(result) -- < `resolve()` value here
print(result)
end):catch(function(err) -- < `reject()` value here
print(err)
end)
This a Promise-like implementation that I'm doing for my neovim plugin which I'm trying to get a similar API as the Javascript Promise.
My question here is, how can I type this to the callee function knows what this is going to be returned from that callback? Currently, I'm trying to play around with @generic but, I can't get the server to properly understand what I mean by my types:
local Promise = {}
---@generic T
---@class Promise<T>
---@field new(executor: fun(resolve: fun(result: T), reject: fun(err: any)))): Promise
---@field next(fn: fun(result: T)): Promise <<<<< here I'm returning `self`
---@field catch(fn: fun(err: any)): Promise <<<<< here I'm returning `self` as well
function Promise:new(executor)
local promise = { ... }
-- ... some operations
return setmetatable(promise, {
__index = self,
})
end
function Promise:next(fn)
-- some operations...
return self
end
function Promise:catch(fn)
-- some operations...
return self
end
----------------------
-- Here is how I want to use it:
---@return Promise<string>
function my_function_that_return_promise()
return Promise:new(function(resolve, reject)
-- .....
resolve("hello")
end)
end
my_function_that_return_promise():next(function(result)
print(result) -- << here I want the server to show `result` is a `string`
end)
For reference, this is how we can do this exactly thing using typescript:
const myPromise = new Promise<string>((resolve, reject) => {
// ...
resolve("hello")
})
myPromise
.then((result) => console.log(result)) // < `result` will have `string` type
.catch((err) => console.log(err))
Thank you for the awesome work! Sorry if I didn't make myself clear, let me know if I need to provide any further information.
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 các annotation @generic và @class trong ví dụ Promise, đồng thời truy vết cách language server hiện suy luận các kiểu callback thông qua new(), next() và catch(). Hoàn thành có nghĩa là xác định liệu việc truyền generic được yêu cầu có được hỗ trợ hay cần một thay đổi được xác định trong hệ thống kiểu, với kết quả kiểu string được suy luận trong callback cuối cù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, neovim
- 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
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100