Skip to main content
Version: Next

Rsvim API

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

RsvimBuf

The Rsvim.buf global object for Vim buffers.

Example

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

RsvimCmd

The Rsvim.cmd global object for Ex commands.

Example

// Create a alias to 'Rsvim.cmd'.
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;

General APIs

These APIs are general for common javascript-based runtime, similar to Deno APIs.

ClassDescription

RsvimFs

The Rsvim.fs global object for file system and file IO.

Example

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

RsvimRt

The Rsvim.rt global object for javascript runtime (editor process).

Example

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

Global Object

The global object.

ClassDescription

Rsvim

The Rsvim global object.

Example

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

Other

NamespaceDescription

RsvimCmd

RsvimFs