diff options
| author | bfredl <bjorn.linse@gmail.com> | 2022-04-08 16:55:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-08 16:55:47 +0200 |
| commit | c26d70d5817e2a53d974da0cbdde87a86576acfc (patch) | |
| tree | 34ed8d5ceae42de0b03ea014e21f0dc300da25cc /runtime | |
| parent | 56ee7c29ab30c893b2a708277d83943f1455e52a (diff) | |
| parent | 30bc02c6364f384e437a6f53b057522d585492fc (diff) | |
| download | rneovim-c26d70d5817e2a53d974da0cbdde87a86576acfc.tar.gz rneovim-c26d70d5817e2a53d974da0cbdde87a86576acfc.tar.bz2 rneovim-c26d70d5817e2a53d974da0cbdde87a86576acfc.zip | |
Merge pull request #17786 from gpanders/autocmd-args
feat(api)!: pass args table to autocommand callbacks
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 25 |
1 files changed, 21 insertions, 4 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index b383c5eaef..095f74b65d 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -3240,7 +3240,7 @@ nvim_create_autocmd({event}, {*opts}) *nvim_create_autocmd()* < Parameters: ~ - {event} (String|Array) The event or events to register + {event} (string|array) The event or events to register this autocommand {opts} Dictionary of autocommand options: • group (string|integer) optional: the @@ -3252,9 +3252,26 @@ nvim_create_autocmd({event}, {*opts}) *nvim_create_autocmd()* Cannot be used with {pattern}. • desc (string) optional: description of the autocommand. - • callback (function|string) optional: Lua - function or Vim function (as string) to execute - on event. Cannot be used with {command} + • callback (function|string) optional: if a + string, the name of a Vimscript function to + call when this autocommand is triggered. + Otherwise, a Lua function which is called when + this autocommand is triggered. Cannot be used + with {command}. Lua callbacks can return true + to delete the autocommand; in addition, they + accept a single table argument with the + following keys: + • id: (number) the autocommand id + • event: (string) the name of the event that + triggered the autocommand |autocmd-events| + • group: (number|nil) the autocommand group id, + if it exists + • match: (string) the expanded value of + |<amatch>| + • buf: (number) the expanded value of |<abuf>| + • file: (string) the expanded value of + |<afile>| + • command (string) optional: Vim command to execute on event. Cannot be used with {callback} |