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. These options will change the editor's behavior and suit user's personal habits. There are 3 kinds of editor option: Global options: Options that are global that you use one value for all Rsvim component instances such as buffer, window, statusline, etc. When you change the option, it will take effect immediately and affect all existing instances. Local options: Options that only apply to one component instance, each instance has its own copy of this option, thus each can have its own value. This allow you to set an option in one instance, without modifying other instances. Global local options: Options that are global, and will be copy to a newly created Rsvim component instance. A global-local-option always has its corresponding local-option. When you change the option, it only will apply to the newly created instances, but cannot modify existing instances. 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. These options will change the editor's behavior and suit user's personal habits.

There are 3 kinds of editor option:

Global options: Options that are global that you use one value for all Rsvim component instances such as buffer, window, statusline, etc. When you change the option, it will take effect immediately and affect all existing instances.
Local options: Options that only apply to one component instance, each instance has its own copy of this option, thus each can have its own value. This allow you to set an option in one instance, without modifying other instances.
Global local options: Options that are global, and will be copy to a newly created Rsvim component instance. A global-local-option always has its corresponding local-option. When you change the option, it only will apply to the newly created instances, but cannot modify existing instances.

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;