aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorGregory Anders <8965202+gpanders@users.noreply.github.com>2022-05-18 09:51:26 -0600
committerGitHub <noreply@github.com>2022-05-18 09:51:26 -0600
commit8a9ab88945cdabcbd23f23406353ec6110fefa83 (patch)
tree5e71bf2543032471d30fce29ced806bf07021bfd /runtime
parentd7dd6007167eac919205404bc4e556237118a7a7 (diff)
downloadrneovim-8a9ab88945cdabcbd23f23406353ec6110fefa83.tar.gz
rneovim-8a9ab88945cdabcbd23f23406353ec6110fefa83.tar.bz2
rneovim-8a9ab88945cdabcbd23f23406353ec6110fefa83.zip
feat(api): enable nvim_exec_autocmds to pass arbitrary data (#18613)
Add a "data" key to nvim_exec_autocmds that passes arbitrary data (API objects) to autocommand callbacks.
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/api.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 86ec05417c..7c669e3c9d 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -3469,6 +3469,8 @@ nvim_create_autocmd({event}, {*opts}) *nvim_create_autocmd()*
• buf: (number) the expanded value of |<abuf>|
• file: (string) the expanded value of
|<afile>|
+ • data: (any) arbitrary data passed to
+ |nvim_exec_autocmds()|
• command (string) optional: Vim command to
execute on event. Cannot be used with
@@ -3544,6 +3546,9 @@ nvim_exec_autocmds({event}, {*opts}) *nvim_exec_autocmds()*
• modeline (bool) optional: defaults to true.
Process the modeline after the autocommands
|<nomodeline>|.
+ • data (any): arbitrary data to send to the
+ autocommand callback. See
+ |nvim_create_autocmd()| for details.
See also: ~
|:doautocmd|