tuil
ReferencePackages@mwillbanks/tuil-editorAPI

VimState

interface exported by @mwillbanks/tuil-editor.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-editor.

export interface VimState {
  readonly mode: VimMode;
  readonly count: number;
  readonly pendingOperator?: "delete" | "change" | "yank";
  readonly commandLine: string;
  readonly registers: Readonly<Record<string, string>>;
  readonly marks: Readonly<Record<string, EditorPosition>>;
}

Members

MemberTypeRequiredDescriptionRelated types
modeVimModeYesThe mode member uses the VimMode contract.VimMode
countnumberYesThe count member uses the number contract.
pendingOperator"delete" | "change" | "yank" | undefinedNoThe pendingOperator member uses the "delete" | "change" | "yank" | undefined contract.
commandLinestringYesThe commandLine member uses the string contract.
registersReadonly<Record<string, string>>YesThe registers member uses the Readonly<Record<string, string>> contract.
marksReadonly<Record<string, EditorPosition>>YesThe marks member uses the Readonly<Record<string, EditorPosition>> contract.EditorPosition

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-editor

On this page