mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-26 12:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: getreg() type #34215

Browse Source 
```lua
---@type string
local _a = vim.fn.getreg('a', 1)

---@type string[]
local _b = vim.fn.getreg('a', 1, 1)
```
This commit is contained in:
phanium
2025-06-05 00:26:56 +08:00
committed by GitHub
parent 442dade5be
commit f577bb024e
3 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
runtime/doc/vimfn.txt
View File

@@ -4089,6 +4089,7 @@ getreg([{regname} [, 1 [, {list}]]]) *getreg()*
Parameters: ~ Parameters: ~
• {regname} (`string?`) • {regname} (`string?`)
• {expr} (`any?`)
• {list} (`nil|false?`) • {list} (`nil|false?`)
Return: ~ Return: ~

8
runtime/lua/vim/_meta/vimfn.lua generated
View File

@@ -3684,14 +3684,16 @@ function vim.fn.getqflist(what) end
--- If {regname} is not specified, |v:register| is used. --- If {regname} is not specified, |v:register| is used.
--- ---
--- @param regname? string --- @param regname? string
--- @param expr? any
--- @param list? nil|false --- @param list? nil|false
--- @return string --- @return string
function vim.fn.getreg(regname, list) end function vim.fn.getreg(regname, expr, list) end
--- @param regname string --- @param regname string
--- @param expr any
--- @param list true|number|string|table --- @param list true|number|string|table
--- @return string|string[] --- @return string[]
function vim.fn.getreg(regname, list) end function vim.fn.getreg(regname, expr, list) end
--- Returns detailed information about register {regname} as a --- Returns detailed information about register {regname} as a
--- Dictionary with the following entries: --- Dictionary with the following entries:

6
src/nvim/eval.lua
View File

@@ -4569,7 +4569,7 @@ M.funcs = {
]=], ]=],
name = 'getreg', name = 'getreg',
params = { { 'regname', 'string' }, { 'list', 'nil|false' } }, params = { { 'regname', 'string' }, { 'expr', 'any' }, { 'list', 'nil|false' } },
signature = 'getreg([{regname} [, 1 [, {list}]]])', signature = 'getreg([{regname} [, 1 [, {list}]]])',
returns = 'string', returns = 'string',
}, },
@@ -4577,8 +4577,8 @@ M.funcs = {
args = { 3 }, args = { 3 },
base = 1, base = 1,
name = 'getreg', name = 'getreg',
params = { { 'regname', 'string' }, { 'list', 'true|number|string|table' } }, params = { { 'regname', 'string' }, { 'expr', 'any' }, { 'list', 'true|number|string|table' } },
returns = 'string|string[]', returns = 'string[]',
}, },
getreginfo = { getreginfo = {
args = { 0, 1 }, args = { 0, 1 },