From e9a35f3e76c64062e688ff7ec16db0bda03df2ff Mon Sep 17 00:00:00 2001 From: alek13 Date: Sat, 1 Jun 2024 15:48:09 +0300 Subject: [PATCH] Add `HTTPApiTable` class definition into `mt-ide-helper`. Relates to lord-server/lord#1402 --- classes/HTTPApiTable.lua | 23 +++++++++++++++++++++++ minetest_types.lua | 2 ++ 2 files changed, 25 insertions(+) create mode 100644 classes/HTTPApiTable.lua diff --git a/classes/HTTPApiTable.lua b/classes/HTTPApiTable.lua new file mode 100644 index 0000000..77b79f3 --- /dev/null +++ b/classes/HTTPApiTable.lua @@ -0,0 +1,23 @@ +--- @class HTTPRequestHandle + +--- @class HTTPApiTable +local HTTPApiTable = {} + +--- Performs given request asynchronously and calls callback upon completion. +--- Use this HTTP function if you are unsure, the others are for advanced use. +--- +--- @param request HTTPRequest +--- @param callback fun(result:HTTPRequestResult) +function HTTPApiTable:fetch(request, callback) end + +--- Performs given request asynchronously and returns handle for `HTTPApiTable.fetch_async_get()`. +--- +--- @param request HTTPRequest +--- @return HTTPRequestHandle +function HTTPApiTable:fetch_async(request) end +--- Return response data for given asynchronous HTTP request. +--- +--- @param handle HTTPRequestHandle +--- @return HTTPRequestResult +function HTTPApiTable:fetch_async_get(handle) end + diff --git a/minetest_types.lua b/minetest_types.lua index eaeed08..a3cb5a0 100644 --- a/minetest_types.lua +++ b/minetest_types.lua @@ -1963,6 +1963,8 @@ function minetest.read_schematic(schematic, options) end --- * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN --- A LOCAL VARIABLE!** --- +--- @return HTTPApiTable +--- --- [View in lua_api.txt](https://github.com/minetest/minetest/blob/5.4.1/doc/lua_api.txt#L5606-L5616) function minetest.request_http_api() end