mirror of
https://github.com/folke/snacks.nvim
synced 2025-07-07 13:15:08 +00:00
76 lines
2.5 KiB
Text
76 lines
2.5 KiB
Text
*snacks-bufdelete* snacks_bufdelete
|
|
|
|
==============================================================================
|
|
Table of Contents *snacks-bufdelete-table-of-contents*
|
|
|
|
1. Types |snacks-bufdelete-types|
|
|
2. Module |snacks-bufdelete-module|
|
|
- Snacks.bufdelete() |snacks-bufdelete-module-snacks.bufdelete()|
|
|
- Snacks.bufdelete.all() |snacks-bufdelete-module-snacks.bufdelete.all()|
|
|
- Snacks.bufdelete.delete()|snacks-bufdelete-module-snacks.bufdelete.delete()|
|
|
- Snacks.bufdelete.other()|snacks-bufdelete-module-snacks.bufdelete.other()|
|
|
Delete buffers without disrupting window layout.
|
|
|
|
If the buffer you want to close has changes, a prompt will be shown to save or
|
|
discard.
|
|
|
|
|
|
==============================================================================
|
|
1. Types *snacks-bufdelete-types*
|
|
|
|
>lua
|
|
---@class snacks.bufdelete.Opts
|
|
---@field buf? number Buffer to delete. Defaults to the current buffer
|
|
---@field file? string Delete buffer by file name. If provided, `buf` is ignored
|
|
---@field force? boolean Delete the buffer even if it is modified
|
|
---@field filter? fun(buf: number): boolean Filter buffers to delete
|
|
---@field wipe? boolean Wipe the buffer instead of deleting it (see `:h :bwipeout`)
|
|
<
|
|
|
|
|
|
==============================================================================
|
|
2. Module *snacks-bufdelete-module*
|
|
|
|
|
|
`Snacks.bufdelete()` *Snacks.bufdelete()*
|
|
|
|
>lua
|
|
---@type fun(buf?: number|snacks.bufdelete.Opts)
|
|
Snacks.bufdelete()
|
|
<
|
|
|
|
|
|
`Snacks.bufdelete.all()` *Snacks.bufdelete.all()*
|
|
|
|
Delete all buffers
|
|
|
|
>lua
|
|
---@param opts? snacks.bufdelete.Opts
|
|
Snacks.bufdelete.all(opts)
|
|
<
|
|
|
|
|
|
`Snacks.bufdelete.delete()` *Snacks.bufdelete.delete()*
|
|
|
|
Delete a buffer: - either the current buffer if `buf` is not provided - or the
|
|
buffer `buf` if it is a number - or every buffer for which `buf` returns true
|
|
if it is a function
|
|
|
|
>lua
|
|
---@param opts? number|snacks.bufdelete.Opts
|
|
Snacks.bufdelete.delete(opts)
|
|
<
|
|
|
|
|
|
`Snacks.bufdelete.other()` *Snacks.bufdelete.other()*
|
|
|
|
Delete all buffers except the current one
|
|
|
|
>lua
|
|
---@param opts? snacks.bufdelete.Opts
|
|
Snacks.bufdelete.other(opts)
|
|
<
|
|
|
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|