VimApi.map method

VimApi › map

Unofficial

Map one key sequence to another, allowing the result to be remapped further. Implements Vim's :map — mapping ; to :, which in Vim is :map ; :, is map(';', ':') here.

Signature:

map(lhs: string, rhs: string, ctx?: VimKeyMappingContext | undefined): void

Parameters:

Parameter	Type	Description
lhs	string	The key sequence to map.
rhs	string	What it is mapped to.
ctx?	VimKeyMappingContext | undefined	The mode the mapping applies in, corresponding to :nmap, :vmap and :imap. Omitted applies it in every mode.

Returns: void