Skip to content

VimOperatorKeyMapping

Unofficial

A key mapping that runs an operator, which transforms the range a following motion selects.

Import:

import type { VimOperatorKeyMapping } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface VimOperatorKeyMapping extends VimKeyMappingBase

Extends: VimKeyMappingBase

Properties

PropertyTypeDescription
context?VimKeyMappingContextThe mode this mapping applies in. Omitted means it applies in every mode.
(Inherited from VimKeyMappingBase)
exitVisualBlock?booleanWhether running the command leaves visual block mode.
(Inherited from VimKeyMappingBase)
expectLiteralNext?booleanWhether the next key typed is taken literally rather than matched against further mappings.
(Inherited from VimKeyMappingBase)
interlaceInsertRepeat?booleanWhether repeating the command in insert mode interleaves it with the recorded keystrokes.
(Inherited from VimKeyMappingBase)
isEdit?booleanWhether the command counts as an edit, making it repeatable with ..
(Inherited from VimKeyMappingBase)
keysstringThe key sequence that triggers this mapping.
(Inherited from VimKeyMappingBase)
noremap?booleanWhether the mapping refuses to be remapped further.
(Inherited from VimKeyMappingBase)
operatorstringThe name the operator was registered under.
operatorArgs?VimOperatorArgsThe arguments passed to the operator.
repeatOverride?numberA repeat count that overrides whatever the user typed.
(Inherited from VimKeyMappingBase)
type'operator'Discriminates this mapping as an operator.