aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_meta/vimfn.lua
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2023-08-17 11:47:40 +0800
committerGitHub <noreply@github.com>2023-08-17 11:47:40 +0800
commit8861f2af72481b1759a6935afa6dce2aae512359 (patch)
tree292843cc0ce14205b328fec6b75c1ad9a0ad7c9b /runtime/lua/vim/_meta/vimfn.lua
parent22d9338afceae5f8ef3845f152dea07a19d512d1 (diff)
parent3117dc70f1e60569f5c3cc0eee5f5005081722b5 (diff)
downloadrneovim-8861f2af72481b1759a6935afa6dce2aae512359.tar.gz
rneovim-8861f2af72481b1759a6935afa6dce2aae512359.tar.bz2
rneovim-8861f2af72481b1759a6935afa6dce2aae512359.zip
Merge pull request #24747 from zeertzjq/vim-8.2.1969
vim-patch:8.2.{1969,1971,2075}: mapnew()
Diffstat (limited to 'runtime/lua/vim/_meta/vimfn.lua')
-rw-r--r--runtime/lua/vim/_meta/vimfn.lua12
1 files changed, 12 insertions, 0 deletions
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index d1173e8a42..b48e2beb8d 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -4922,6 +4922,8 @@ function vim.fn.log10(expr) end
--- {expr1} must be a |List|, |Blob| or |Dictionary|.
--- Replace each item in {expr1} with the result of evaluating
--- {expr2}. For a |Blob| each byte is replaced.
+--- If the item type changes you may want to use |mapnew()| to
+--- create a new List or Dictionary.
---
--- {expr2} must be a |string| or |Funcref|.
---
@@ -5078,6 +5080,16 @@ function vim.fn.maparg(name, mode, abbr, dict) end
--- @return any
function vim.fn.mapcheck(name, mode, abbr) end
+--- Like |map()| but instead of replacing items in {expr1} a new
+--- List or Dictionary is created and returned. {expr1} remains
+--- unchanged. Items can still be changed by {expr2}, if you
+--- don't want that use |deepcopy()| first.
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @return any
+function vim.fn.mapnew(expr1, expr2) end
+
--- Restore a mapping from a dictionary returned by |maparg()|.
--- {mode} and {abbr} should be the same as for the call to
--- |maparg()|. *E460*