Skip to main content
Module

x/denops_std/mod.ts

📚 Standard module for denops.vim
Go to Latest
import * as denopsStd from "https://deno.land/x/denops_std@v4.1.6/mod.ts";

Standard module for denops.vim.

This module is assumed to be used for developing denops plugins. The code is assumed to be called in a dedicated worker thread of each plugins.

By using this module, developers can write Vim/Neovim denops plugins like:

import { Denops } from "./mod.ts";
import * as fn from "./function/mod.ts";
import * as vars from "./variable/mod.ts";
import * as helper from "./helper/mod.ts";

import * as unknownutil from "https://deno.land/x/unknownutil/mod.ts";

export async function main(denops: Denops): Promise<void> {
  denops.dispatcher = {
    async say(where: unknown): Promise<void> {
      unknownutil.assertString(where);

      const name = await fn.input(denops, "Your name: ");
      const progname = await vars.v.get(denops, "progname");
      const messages = [
        `Hello ${where}.`,
        `Your name is ${name}.`,
        `This is ${progname}.`,
      ];
      await helper.echo(denops, messages.join("\n"));
    },
  };

  await helper.execute(
    denops,
    `
    command! HelloWorld call denops#notify("${denops.name}", "say", ["World"])
    command! HelloDenops call denops#notify("${denops.name}", "say", ["Denops"])
    `,
  );
}

See Denops Documentation or denops-helloworld.vim for more details.

Classes

Batch error which is raised when one of function fails during batch process

Interfaces

Denpos is a facade instance visible from each denops plugins.

Method dispatcher

Environment meta information.

Type Aliases

Context which is expanded to the local namespace (l:)