Skip to main content
Module

x/denops_std/function/nvim/mod.ts>nvim_set_client_info

📚 Standard module for denops.vim
Latest
function nvim_set_client_info
import { nvim_set_client_info } from "https://deno.land/x/denops_std@v6.5.0/function/nvim/mod.ts";

Self-identifies the client.

The client/plugin/application should call this after connecting, to provide hints about its identity and purpose, for debugging and orchestration.

Can be called more than once; the caller should merge old info if appropriate. Example: library first identifies the channel, then a plugin using that library later identifies itself.

Note: "Something is better than nothing". You don't need to include all the fields.

Attributes: RPC only

Parameters:

  • {name} Short name for the connected client
  • {version} Dictionary describing the version, with these (optional) keys: - "major" major version (defaults to 0 if not set, for no release yet) - "minor" minor version - "patch" patch number - "prerelease" string describing a prerelease, like "dev" or "beta1" - "commit" hash or similar identifier of commit
  • {type} Must be one of the following values. Client libraries should default to "remote" unless overridden by the user. - "remote" remote client connected to Nvim. - "ui" gui frontend - "embedder" application using Nvim as a component (for example, IDE/editor implementing a vim mode). - "host" plugin host, typically started by nvim - "plugin" single plugin, started by nvim
  • {methods} Builtin methods in the client. For a host, this does not include plugin methods which will be discovered later. The key should be the method name, the values are dicts with these (optional) keys (more keys may be added in future versions of Nvim, thus unknown keys are ignored. Clients must only use keys defined in this or later versions of Nvim): - "async" if true, send as a notification. If false or unspecified, use a blocking request - "nargs" Number of arguments. Could be a single integer or an array of two integers, minimum and maximum inclusive.
  • {attributes} Arbitrary string:string map of informal client properties. Suggested keys: - "website": Client homepage URL (e.g. GitHub repository) - "license": License description ("Apache 2", "GPLv3", "MIT", …) - "logo": URI or path to image, preferably small logo or icon. .png or .svg format is preferred.

Parameters

denops: Denops
name: unknown
version: unknown
type: unknown
methods: unknown
attributes: unknown

Returns

Promise<unknown>