uv_check_t.lua 804 B

1234567891011121314151617181920212223242526272829303132
  1. ---@meta
  2. -- luacheck: no unused args
  3. error('Cannot require a meta file')
  4. --- Check handles will run the given callback once per loop iteration, right after
  5. --- polling for I/O.
  6. ---
  7. --- ```lua
  8. --- local check = uv.new_check()
  9. --- check:start(function()
  10. --- print("After I/O polling")
  11. --- end)
  12. --- ```
  13. ---
  14. ---@class uv.uv_check_t : uv.uv_handle_t
  15. local check = {} -- luacheck: no unused
  16. --- Start the handle with the given callback.
  17. ---
  18. ---@param callback function
  19. ---@return 0|nil success
  20. ---@return uv.error.message|nil err
  21. ---@return uv.error.name|nil err_name
  22. function check:start(callback) end
  23. --- Stop the handle, the callback will no longer be called.
  24. ---
  25. ---@return 0|nil success
  26. ---@return uv.error.message|nil err
  27. ---@return uv.error.name|nil err_name
  28. function check:stop() end