Version: Next

Rsvim API

The Rsvim global object, it contains two groups:

Editor APIs

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

Class Description

Class	Description
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;`

The Rsvim.buf global object for Vim buffers.

Example

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

The Rsvim.cmd global object for Ex commands.

Example

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

The Rsvim.opt global object for global editor options.

Example

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

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

Class Description

Class	Description
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;`

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

Example

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

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

Example

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

The global object.

Class Description

Class	Description
Rsvim	The `Rsvim` global object. Example `// Create a alias to 'Rsvim'. const vim = Rsvim;`

The Rsvim global object.

Example

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

Namespace	Description
RsvimCmd	‐
RsvimFs	‐