Sovereignty/luau-promise
1
0
Fork 0
mirror of https://github.com/AmberGraceRblx/luau-promise.git synced 2025-04-24 15:50:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update doc comments for new moonwave version

Browse source
This commit is contained in:
eryn L. K 2021-12-27 21:28:28 -05:00
parent b80fa76bc8
commit 079bd8e6f5
1 changed files with 22 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
lib/init.lua
View file

@ -345,14 +345,14 @@ end
@param executor (resolve: (...: any) -> (), reject: (...: any) -> (), onCancel: (abortHandler?: () -> ()) -> boolean) -> () @param executor (resolve: (...: any) -> (), reject: (...: any) -> (), onCancel: (abortHandler?: () -> ()) -> boolean) -> ()
@return Promise @return Promise
]=] ]=]
function Promise.defer(callback) function Promise.defer(executor)
local traceback = debug.traceback(nil, 2) local traceback = debug.traceback(nil, 2)
local promise local promise
promise = Promise._new(traceback, function(resolve, reject, onCancel) promise = Promise._new(traceback, function(resolve, reject, onCancel)
local connection local connection
connection = Promise._timeEvent:Connect(function() connection = Promise._timeEvent:Connect(function()
connection:Disconnect() connection:Disconnect()
local ok, _, result = runExecutor(traceback, callback, resolve, reject, onCancel) local ok, _, result = runExecutor(traceback, executor, resolve, reject, onCancel)
if not ok then if not ok then
reject(result[1]) reject(result[1])
@ -443,11 +443,12 @@ end
end) end)
``` ```
@param callback (...: any) -> ...any @param callback (...: T...) -> ...any
@param ... T... -- Additional arguments passed to `callback`
@return Promise @return Promise
]=] ]=]
function Promise.try(...) function Promise.try(callback, ...)
return Promise._try(debug.traceback(nil, 2), ...) return Promise._try(debug.traceback(nil, 2), callback, ...)
end end
--[[ --[[
@ -589,14 +590,14 @@ end
@param reducer (accumulator: U, value: T, index: number) -> U | Promise<U> @param reducer (accumulator: U, value: T, index: number) -> U | Promise<U>
@param initialValue U @param initialValue U
]=] ]=]
function Promise.fold(list, callback, initialValue) function Promise.fold(list, reducer, initialValue)
assert(type(list) == "table", "Bad argument #1 to Promise.fold: must be a table") assert(type(list) == "table", "Bad argument #1 to Promise.fold: must be a table")
assert(type(callback) == "function", "Bad argument #2 to Promise.fold: must be a function") assert(type(reducer) == "function", "Bad argument #2 to Promise.fold: must be a function")
local accumulator = Promise.resolve(initialValue) local accumulator = Promise.resolve(initialValue)
return Promise.each(list, function(resolvedElement, i) return Promise.each(list, function(resolvedElement, i)
accumulator = accumulator:andThen(function(previousValueResolved) accumulator = accumulator:andThen(function(previousValueResolved)
return callback(previousValueResolved, resolvedElement, i) return reducer(previousValueResolved, resolvedElement, i)
end) end)
end):andThenReturn(accumulator) end):andThenReturn(accumulator)
end end
@ -620,10 +621,10 @@ end
@param count number @param count number
@return Promise<{T}> @return Promise<{T}>
]=] ]=]
function Promise.some(promises, amount) function Promise.some(promises, count)
assert(type(amount) == "number", "Bad argument #2 to Promise.some: must be a number") assert(type(count) == "number", "Bad argument #2 to Promise.some: must be a number")
return Promise._all(debug.traceback(nil, 2), promises, amount) return Promise._all(debug.traceback(nil, 2), promises, count)
end end
--[=[ --[=[
@ -741,7 +742,7 @@ end
return Promise.race(promises) -- Only returns 1st value to resolve or reject return Promise.race(promises) -- Only returns 1st value to resolve or reject
``` ```
@param promises: {Promise<T>} @param promises {Promise<T>}
@return Promise<T> @return Promise<T>
]=] ]=]
function Promise.race(promises) function Promise.race(promises)
@ -1259,12 +1260,12 @@ end
@param failureHandler (...: any) -> ...any @param failureHandler (...: any) -> ...any
@return Promise<...any> @return Promise<...any>
]=] ]=]
function Promise.prototype:catch(failureCallback) function Promise.prototype:catch(failureHandler)
assert( assert(
failureCallback == nil or type(failureCallback) == "function", failureHandler == nil or type(failureHandler) == "function",
string.format(ERROR_NON_FUNCTION, "Promise:catch") string.format(ERROR_NON_FUNCTION, "Promise:catch")
) )
return self:_andThen(debug.traceback(nil, 2), nil, failureCallback) return self:_andThen(debug.traceback(nil, 2), nil, failureHandler)
end end
--[=[ --[=[
@ -1283,10 +1284,10 @@ end
@param tapHandler (...: any) -> ...any @param tapHandler (...: any) -> ...any
@return Promise<...any> @return Promise<...any>
]=] ]=]
function Promise.prototype:tap(tapCallback) function Promise.prototype:tap(tapHandler)
assert(type(tapCallback) == "function", string.format(ERROR_NON_FUNCTION, "Promise:tap")) assert(type(tapHandler) == "function", string.format(ERROR_NON_FUNCTION, "Promise:tap"))
return self:_andThen(debug.traceback(nil, 2), function(...) return self:_andThen(debug.traceback(nil, 2), function(...)
local callbackReturn = tapCallback(...) local callbackReturn = tapHandler(...)
if Promise.is(callbackReturn) then if Promise.is(callbackReturn) then
local length, values = pack(...) local length, values = pack(...)
@ -1538,12 +1539,9 @@ end
@param doneHandler (status: Status) -> ...any @param doneHandler (status: Status) -> ...any
@return Promise<...any> @return Promise<...any>
]=] ]=]
function Promise.prototype:done(finallyHandler) function Promise.prototype:done(doneHandler)
assert( assert(doneHandler == nil or type(doneHandler) == "function", string.format(ERROR_NON_FUNCTION, "Promise:done"))
finallyHandler == nil or type(finallyHandler) == "function", return self:_finally(debug.traceback(nil, 2), doneHandler, true)
string.format(ERROR_NON_FUNCTION, "Promise:done")
)
return self:_finally(debug.traceback(nil, 2), finallyHandler, true)
end end
--[=[ --[=[