doc: mention that defer_fn applies schedule_wrap (#12601)

This commit is contained in:
Christian Clason
2020-07-07 10:55:40 +02:00
committed by GitHub
parent e49fc4ba1f
commit 91572ddad1
2 changed files with 7 additions and 0 deletions

View File

@@ -467,6 +467,8 @@ end
--- Defers calling `fn` until `timeout` ms passes.
---
--- Use to do a one-shot timer that calls `fn`
--- Note: The {fn} is |schedule_wrap|ped automatically, so API functions are
--- safe to call.
--@param fn Callback to call once `timeout` expires
--@param timeout Number of milliseconds to wait before calling `fn`
--@return timer luv timer object