VimRegister

Unofficial

Both Official Unofficial

Both Own Inherited

One Vim register, holding yanked or deleted text along with how it should be pasted back.

Import:

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

Signature:

export interface VimRegister

Properties

	Property	Type	Description
	blockwise	boolean	Whether the register's text is pasted as a rectangular block.
	insertModeChanges	VimInsertModeChanges[]	The insert-mode sessions recorded into this register, for macro playback.
	keyBuffer	string[]	The register's text, stored as the pieces it was built from.
	linewise	boolean	Whether the register's text is pasted on its own lines rather than inline.
	searchQueries	string[]	The search queries recorded into this register, for macro playback.

Methods

	Method	Returns	Description
	clear()	void	Discard everything the register holds.
	pushInsertModeChanges(changes)	void	Append a recorded insert-mode session to the register.
	pushSearchQuery(query)	void	Append a recorded search query to the register.
	pushText(text, linewise?)	void	Append text to the register, keeping what is already there.
	setText(text?, linewise?, blockwise?)	void	Replace everything the register holds with the given text.
	toString()	string	Get the register's text as a single string.

---

Links to this page:

• VimRegisterController