VimOperatorArgs

Unofficial

Both Official Unofficial

Both Own Inherited

Arguments describing how a Vim operator transforms the range a motion selected.

Import:

import type { VimOperatorArgs } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface VimOperatorArgs

Properties

	Property	Type	Description
	fullLine?	boolean	Whether the operator consumes the whole line including its terminator, rather than stopping at the last character.
	indentRight?	boolean	Whether an indent operator adds indentation. false removes it.
	keepCursor?	boolean	Whether the cursor stays where it was instead of moving to the start of the affected range.
	lastSel?	VimLastSelectionRange	The previous visual selection, for operators that repeat it.
	linewise?	boolean	Whether the operator applies to whole lines rather than a character range.
	registerName?	null | string	The register the operator reads from or writes to. Defaults to the unnamed register.
	repeat?	number	How many times the operator is applied.
	selectedCharacter?	string	The character the operator was given, for operators such as r that take one.
	shouldMoveCursor?	boolean	Whether the cursor moves to the end of the affected range once the operator has run.
	toLower?	boolean	Whether a case-changing operator makes the text lower case. false makes it upper case, and omitting it toggles the case of each character.

---

Links to this page:

• VimInputState
• VimOperatorKeyMapping
• VimOperatorMotionKeyMapping