diff options
| author | TJ DeVries <devries.timothyj@gmail.com> | 2022-03-12 15:12:02 -0500 |
|---|---|---|
| committer | bfredl <bjorn.linse@gmail.com> | 2022-03-31 14:30:42 +0200 |
| commit | b80651eda9c50d4e438f02af9311b18c5c202656 (patch) | |
| tree | 3dd6baff0916f92df5b26a2a905b4b2af7bcf2c1 /runtime | |
| parent | b2bd8004161853f53bf687b0b90119055fcb5cfb (diff) | |
| download | rneovim-b80651eda9c50d4e438f02af9311b18c5c202656.tar.gz rneovim-b80651eda9c50d4e438f02af9311b18c5c202656.tar.bz2 rneovim-b80651eda9c50d4e438f02af9311b18c5c202656.zip | |
feat(api): nvim_clear_autocmd
Co-authored-by: Christian Clason <christian.clason@uni-due.de>
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 0a8a3e9a2c..b25a43a952 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -3151,6 +3151,34 @@ nvim_tabpage_set_var({tabpage}, {name}, {value}) ============================================================================== Autocmd Functions *api-autocmd* +nvim_clear_autocmd({*opts}) *nvim_clear_autocmd()* + Clear all autocommands that match the corresponding {opts}. To + delete a particular autocmd, see |nvim_del_autocmd|. + + Parameters: ~ + {opts} Parameters + • event: (string|table) Examples: + • event: "pat1" + • event: { "pat1" } + • event: { "pat1", "pat2", "pat3" } + + • pattern: (string|table) + • pattern or patterns to match exactly. + • For example, if you have `*.py` as that + pattern for the autocmd, you must pass + `*.py` exactly to clear it. `test.py` will + not match the pattern. + + • defaults to clearing all patterns. + • NOTE: Cannot be used with {buffer} + + • buffer: (bufnr) + • clear only |autocmd-buflocal| autocommands. + • NOTE: Cannot be used with {pattern} + + • group: (string|int) The augroup name or id. + • NOTE: If not passed, will only delete autocmds not in any group. + nvim_create_augroup({name}, {*opts}) *nvim_create_augroup()* Create or get an autocommand group |autocmd-groups|. |