Skip to main content
Version: Next

Rsvim APIs

The Rsvim global object, it contains two groups:

  • General APIs.
  • Editor APIs.

Editor APIs​

These APIs are specific for editor, such as buffers, windows, key mappings, etc.

ClassDescription

RsvimCmd

The Rsvim.cmd global object for ex commands.

tip

The "ex command" mostly describes the product function, i.e. when user types ":" in normal mode, user can move cursor to command-line and input commands. Rather than referring to the "ex commands" in Vim editor.

Example

const cmd = Rsvim.cmd;

RsvimOpt

The Rsvim.opt global object for global editor options.

Example

// Create a alias to 'Rsvim.opt'.
const opt = Rsvim.opt;

Global Object​

The global object.

ClassDescription

Rsvim

The Rsvim global object, it contains multiple sub fields:

  • Rsvim.opt: Global options.
  • Rsvim.cmd: Ex commands.

Example

// Create a alias to 'Rsvim'.
const vim = Rsvim;