Skip to content

VimGlobalState

Unofficial

The Vim state shared by every editor: registers, macros, search and command history, and the jump list.

Import:

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

Signature:

export interface VimGlobalState

Properties

PropertyTypeDescription
exCommandHistoryControllerVimHistoryControllerThe history of the Ex command prompt.
isReversed?booleanWhether the active search runs towards the start of the document. Read and written through the per-editor search state.
jumpListVimJumpListThe ring buffer of positions jumped from.
lastCharacterSearchVimLastCharacterSearchThe most recent character search, so ; and , can repeat it.
lastSubstituteReplacePartstring | undefinedThe replacement text of the last :substitute, so a later one can reuse it.
macroModeStateVimMacroModeStateMacro recording and playback state.
query?null | RegExpThe active search query. Read and written through the per-editor search state.
registerControllerVimRegisterControllerEvery register, and the routing that decides which one an operator uses.
searchHistoryControllerVimHistoryControllerThe history of the search prompt.
searchIsReversedbooleanWhether the last search ran towards the start of the document.
searchQuerynull | RegExpThe query the last search ran with, or null when nothing has been searched for yet.

Links to this page: