Vim Function Documentation: map(), maparg()

{expr} (`string`) • {expr1} (`any[]?`) Return: ~ (`any`) map({expr1}, {expr2}) *map()* {expr1} must be a |List|, |String|, |Blob| or |Dictionary|. When {expr1} is a |List| or |Dictionary|, replace each item in {expr1} with the result of evaluating {expr2}. For a |Blob| each byte is replaced. For a |String|, each character, including composing characters, 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|. If {expr2} is a |String|, inside {expr2} |v:val| has the value of the current item. For a |Dictionary| |v:key| has the key of the current item and for a |List| |v:key| has the index of the current item. For a |Blob| |v:key| has the index of the current byte. For a |String| |v:key| has the index of the current character. Example: >vim call map(mylist, '"> " .. v:val .. " <"') < This puts "> " before and " <" after each item in "mylist". Note that {expr2} is the result of an expression and is then used as an expression again. Often it is good to use a |literal-string| to avoid having to double backslashes. You still have to double ' quotes If {expr2} is a |Funcref| it is called with two arguments: 1. The key or the index of the current item. 2. the value of the current item. The function must return the new value of the item. Example that changes each value by "key-value": >vim func KeyValue(key, val) return a:key .. '-' .. a:val endfunc call map(myDict, function('KeyValue')) < It is shorter when using a |lambda|: >vim call map(myDict, {key, val -> key .. '-' .. val}) < If you do not use "val" you can leave it out: >vim call map(myDict, {key -> 'item: ' .. key}) < If you do not use "key" you can use a short name: >vim call map(myDict, {_, val -> 'item: ' .. val}) < The operation is done in-place for a |List| and |Dictionary|. If you want it to remain unmodified make a copy first: >vim let tlist = map(copy(mylist), ' v:val .. "\t"') < Returns {expr1}, the |List| or |Dictionary| that was filtered, or a new |Blob| or |String|. When an error is encountered while evaluating {expr2} no further items in {expr1} are processed. When {expr2} is a Funcref errors inside a function are ignored, unless it was defined with the "abort" flag. Parameters: ~ • {expr1} (`string|table|any[]`) • {expr2} (`string|function`) Return: ~ (`any`) maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* When {dict} is omitted or zero: Return the rhs of mapping {name} in mode {mode}. The returned String has special characters translated like in the output of the ":map" command listing. When {dict} is TRUE a dictionary is returned, see below. To get a list of all mappings see |maplist()|. When there is no mapping for {name}, an empty String is returned if {dict} is FALSE, otherwise returns an empty Dict. When the mapping for {name} is empty, then "<Nop>" is returned. The {name} can have special key names, like in the ":map" command. {mode} can be one of these strings: "n" Normal "v" Visual (including Select) "o" Operator-pending "i" Insert "c" Cmd-line "s" Select "x" Visual "l" langmap |language-mapping| "t" Terminal "" Normal, Visual and Operator-pending When {mode} is omitted, the modes for "" are used. When {abbr} is there and it is |TRUE| use abbreviations instead of mappings. When {dict} is |TRUE|, return a dictionary describing the mapping, with these items: *mapping-dict* "lhs" The {lhs} of the mapping as it would be typed "lhsraw" The {lhs} of the mapping as raw bytes "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate form, only present

This documentation describes the Vim functions `map()` and `maparg()`. `map()` replaces each item in a list, string, blob, or dictionary with the result of evaluating an expression. `maparg()` returns the right-hand side (rhs) of a mapping in a specified mode, or a dictionary containing details about the mapping, including the left-hand side (lhs) and the rhs.