nvim_runtime_lua

uv.uv_fs_poll_t

supers: uv.uv_handle_t

uv_fs_poll_t - FS Poll handle

[uv_handle_t][] functions also apply.

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.

Methods3 

function uv_fs_poll_t.start(path: string, interval: integer, callback: uv.fs_poll_start.callback) -> (success 0 | nil, err nil | string, err_name uv.error_name | nil)

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.

function uv_fs_poll_t.stop() -> (success 0 | nil, err nil | string, err_name uv.error_name | nil)

Stop the handle, the callback will no longer be called.

function uv_fs_poll_t.getpath() -> (path nil | string, err nil | string, err_name uv.error_name | nil)

Get the path being monitored by the handle.