From b65fb7a406869e572a80ba9acee1e385922c8cb5 Mon Sep 17 00:00:00 2001 From: Michael Martin <3277009+flrgh@users.noreply.github.com> Date: Tue, 13 Dec 2022 09:23:53 -0800 Subject: add luv library annotations --- meta/3rd/luv/library/uv_fs_poll_t.lua | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 meta/3rd/luv/library/uv_fs_poll_t.lua (limited to 'meta/3rd/luv/library/uv_fs_poll_t.lua') diff --git a/meta/3rd/luv/library/uv_fs_poll_t.lua b/meta/3rd/luv/library/uv_fs_poll_t.lua new file mode 100644 index 00000000..2e65cc42 --- /dev/null +++ b/meta/3rd/luv/library/uv_fs_poll_t.lua @@ -0,0 +1,35 @@ +---@meta + +--- FS Poll handles allow the user to monitor a given path for changes. Unlike +--- `uv_fs_event_t`, fs poll handles use `stat` to detect when a file has changed so +--- they can work on file systems where fs event handles can't. +--- +---@class uv.uv_fs_poll_t : uv.uv_handle_t +local fs_poll + +--- Get the path being monitored by the handle. +--- +---@return string|nil path +---@return uv.error.message|nil err +---@return uv.error.name|nil err_name +function fs_poll:getpath() end + +--- Check the file at `path` for changes every `interval` milliseconds. +--- +--- **Note:** For maximum portability, use multi-second intervals. Sub-second +--- intervals will not detect all changes on many file systems. +--- +---@param path string +---@param interval integer +---@param callback uv.fs_poll_start.callback +---@return 0|nil success +---@return uv.error.message|nil err +---@return uv.error.name|nil err_name +function fs_poll:start(path, interval, callback) end + +--- Stop the handle, the callback will no longer be called. +--- +---@return 0|nil success +---@return uv.error.message|nil err +---@return uv.error.name|nil err_name +function fs_poll:stop() end \ No newline at end of file -- cgit v1.2.3