VimMacroModeState

Unofficial

Both Official Unofficial

Both Own Inherited

Tracks macro recording and playback — what q starts and @ replays.

Import:

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

Signature:

export interface VimMacroModeState

Properties

	Property	Type	Description
	isPlaying	boolean	Whether a macro is currently being replayed.
	isRecording	boolean	Whether keystrokes are currently being recorded into a register.
	lastInsertModeChanges	VimInsertModeChanges	The insert-mode edits recorded since the last time insert mode was entered.
	latestRegister	string | undefined	The register being recorded into, or undefined when nothing is being recorded.
	onRecordingDone	((newVal?: string) => void) | undefined	Closes the recording indicator, or undefined when nothing is being recorded.
	replaySearchQueries	string[]	The search queries queued up for the macro currently being replayed.

Methods

	Method	Returns	Description
	enterMacroRecordMode(cm, registerName)	void	Start recording keystrokes into the given register.
	exitMacroRecordMode()	void	Stop recording and close the recording indicator.

---

Links to this page:

• VimGlobalState