chore: update annotation

Author: kevinhwang91

.luarc.json

@@ -15,7 +15,8 @@
 	],
 	"diagnostics.disable": [
 		"param-type-mismatch",
-		"assign-type-mismatch"
+		"assign-type-mismatch",
+		"duplicate-set-field"
 	],
 	"runtime.version": "LuaJIT",
 	"type.castNumberToInteger": true,

lua/async.lua

@@ -47,7 +47,7 @@ local function injectENV(fn)
     }))
 end
 
----Export wait function to someone needs
+---An async function is a function like the async keyword in JavaScript
 ---@param executor fun()
 ---@return Promise
 function Async.sync(executor)
@@ -95,9 +95,9 @@ function Async.sync(executor)
     end)
 end
 
----Export wait function to someone needs, wait function actually have been injected as `await`
----into the executor of async function
----@param p Promise|table
+---Export wait function to someone needs, wait function actually have injected as `await` into
+---the executor of async function
+---@param p Promise|any
 ---@return ...
 function Async.wait(p)
     p = promise.resolve(p)

lua/promise-async/compat.lua

@@ -7,6 +7,7 @@ function M.is51()
     return _G._VERSION:sub(-3) == '5.1' and not jit
 end
 
+---@diagnostic disable: deprecated
 if table.pack then
     M.pack = table.pack
 else
@@ -20,6 +21,7 @@ if table.unpack then
 else
     M.unpack = unpack
 end
+---@diagnostic enable: deprecated
 
 if M.is51() then
     local _pcall, _xpcall = pcall, xpcall

lua/promise.lua

@@ -1,5 +1,4 @@
 local utils = require('promise-async.utils')
-
 local promiseId = {'promise-async'}
 local errFactory = require('promise-async.error')
 local shortSrc = debug.getinfo(1, 'S').short_src
@@ -19,10 +18,8 @@ local REJECTED = 3
 ---@field state PromiseState
 ---@field result any
 ---@field queue table
----@field loop PromiseAsyncLoop
 ---@field needHandleRejection? boolean
 ---@field err? PromiseAsyncError
----@overload fun(executor: PromiseExecutor): Promise
 local Promise = setmetatable({_id = promiseId}, {
     __call = function(self, executor)
         return self.new(executor)
@@ -244,8 +241,6 @@ resolvePromise = function(promise, value)
     end
 end
 
----@param executor PromiseExecutor
----@return Promise
 function Promise.new(executor)
     utils.assertType(executor, 'function')
     ---@type Promise
@@ -262,9 +257,6 @@ function Promise.new(executor)
     return o
 end
 
----@param onFulfilled? fun(value: any)
----@param onRejected? fun(reason: any)
----@return Promise
 function Promise:thenCall(onFulfilled, onRejected)
     local o = Promise.new(noop)
     table.insert(self.queue, {o, onFulfilled, onRejected})
@@ -274,14 +266,10 @@ function Promise:thenCall(onFulfilled, onRejected)
     return o
 end
 
----@param onRejected? fun(reason: any)
----@return Promise
 function Promise:catch(onRejected)
     return self:thenCall(nil, onRejected)
 end
 
----@param onFinally? fun()
----@return Promise
 function Promise:finally(onFinally)
     local function wrapFinally()
         if utils.getCallable(onFinally) then
@@ -299,8 +287,6 @@ function Promise:finally(onFinally)
     end)
 end
 
----@param value? any
----@return Promise
 function Promise.resolve(value)
     local typ = type(value)
     if Promise.isInstance(value, typ) then
@@ -318,8 +304,6 @@ function Promise.resolve(value)
     end
 end
 
----@param reason? any
----@return Promise
 function Promise.reject(reason)
     local o = Promise.new(noop)
     o.state = REJECTED
@@ -328,8 +312,6 @@ function Promise.reject(reason)
     return o
 end
 
----@param values table
----@return Promise
 function Promise.all(values)
     utils.assertType(values, 'table')
     return Promise.new(function(resolve, reject)
@@ -353,8 +335,6 @@ function Promise.all(values)
     end)
 end
 
----@param values table
----@return Promise
 function Promise.allSettled(values)
     utils.assertType(values, 'table')
     return Promise.new(function(resolve, reject)
@@ -380,8 +360,6 @@ function Promise.allSettled(values)
     end)
 end
 
----@param values table
----@return Promise
 function Promise.any(values)
     utils.assertType(values, 'table')
     return Promise.new(function(resolve, reject)
@@ -406,8 +384,6 @@ function Promise.any(values)
     end)
 end
 
----@param values table
----@return Promise
 function Promise.race(values)
     utils.assertType(values, 'table')
     return Promise.new(function(resolve, reject)

typings/async.lua

@@ -1,4 +1,4 @@
----@diagnostic disable: unused-local
+---@diagnostic disable: unused-local, missing-return
 
 ---An async function is a function like the async keyword in JavaScript
 ---@class Async
@@ -7,7 +7,7 @@ local Async = {}
 
 ---Await expressions make promise returning functions behave as though they're synchronous by
 ---suspending execution until the returned promise is fulfilled or rejected.
----@param promise Promise|table
+---@param promise Promise|any
 ---@return ... result The resolved value of the promise.
 function _G.await(promise) end
 

typings/loop.lua

@@ -1,4 +1,4 @@
----@diagnostic disable: unused-local
+---@diagnostic disable: unused-local, missing-return
 
 ---Singleton table, can't be as metatable. Two ways to extend the event loop.
 ---1. Create a new table and implement all methods, assign the new one to `Promise.loop` .

typings/promise.lua

@@ -1,4 +1,4 @@
----@diagnostic disable: unused-local
+---@diagnostic disable: unused-local, missing-return
 
 ---@alias PromiseExecutor fun(resolve: fun(value: any), reject: fun(reason?: any))
 
@@ -15,8 +15,8 @@ local Promise = {}
 function Promise.new(executor) end
 
 ---Attaches callbacks for the resolution and/or rejection of the Promise.
----@param onFulfilled? fun(value: any) The callback to execute when the Promise is resolved.
----@param onRejected? fun(reason: any) The callback to execute when the Promise is rejected.
+---@param onFulfilled? fun(value: any): any The callback to execute when the Promise is resolved.
+---@param onRejected? fun(reason: any): any The callback to execute when the Promise is rejected.
 ---@return Promise promise A Promise for the completion of which ever callback is executed.
 function Promise:thenCall(onFulfilled, onRejected) end