bryan
/
persisted.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document data available in the callbacks

main
olimorris 2023-02-23 11:13:55 +00:00
parent 8e1a5bfb37
commit e9fdae57a7
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -296,9 +296,11 @@ vim.api.nvim_create_autocmd({ "User" }, {
})
```
Session data is also made available to the callback:
Session data is also made available to the callbacks:
```lua
local group = vim.api.nvim_create_augroup("PersistedHooks", {})
vim.api.nvim_create_autocmd({ "User" }, {
pattern = "PersistedTelescopeLoadPre",
group = group,
@ -308,6 +310,8 @@ vim.api.nvim_create_autocmd({ "User" }, {
})
```
The session data available differs depending on the events that are hooked into. For non-telescope events, only the session `name` is available (via `session.data.name`). However for telescope events, the `branch`, `name`, `file_path` and `dir_path` are available.
Finaly, if you're using the excellent [Legendary.nvim](https://github.com/mrjones2014/legendary.nvim) plugin, consider the following snippet format:
```lua