VimExCommandParams

Unofficial

Both Official Unofficial

Both Own Inherited

The parsed form of an Ex command line, handed to the function registered for that command.

Import:

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

Signature:

export interface VimExCommandParams

Properties

	Property	Type	Description
	args?	string[]	The whitespace-separated arguments that followed the command name.
	argString	string	Everything that followed the command name, unsplit.
	commandName	string	The name the command was invoked under, which may be an abbreviation of its full name.
	input	string	The whole command line as the user typed it, including the leading :.
	line	number	The first line of the range the command applies to.
	lineEnd?	number	The last line of the range the command applies to, when a range was given.
	selectionLine	number	The first line of the range, as derived from the current selection.
	selectionLineEnd?	number	The last line of the range, as derived from the current selection.
	setCfg?	object	The option-setting configuration parsed out of a :set command.

---

Links to this page:

• VimKeyToExKeyMapping