mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-08-28 10:01:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

lua: vim.wait allows control of fast events (#13053)

Browse Source 
* lua: vim.wait allows control of fast events

* fixup: remove requirement of function for easier waiting

* fixup: lint

* fixup: bfredl comments
This commit is contained in:
TJ DeVries
2020-10-06 12:58:05 -04:00
committed by GitHub
parent 07fde6c394
commit 7b89353985
3 changed files with 86 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
runtime/doc/lua.txt
View File

@@ -737,13 +737,20 @@ vim.defer_fn({fn}, {timeout}) *vim.defer_fn*
Returns: ~
|vim.loop|.new_timer() object
vim.wait({time}, {callback} [, {interval}]) *vim.wait()*
vim.wait({time} [, {callback}, {interval}, {fast_only}]) *vim.wait()*
Wait for {time} in milliseconds until {callback} returns `true`.
Executes {callback} immediately and at approximately {interval}
milliseconds (default 200). Nvim still processes other events during
this time.
Parameters: ~
{time} Number of milliseconds to wait
{callback} Optional callback. Waits until {callback} returns true
{interval} (Approximate) number of milliseconds to wait between polls
{fast_only} If true, only |api-fast| events will be processed.
If called from while in an |api-fast| event, will
automatically be set to `true`.
Returns: ~
If {callback} returns `true` during the {time}: