/function/nvim/mod.ts | denops_std@v6.4.0

import * as denopsStd from "https://deno.land/x/denops_std@v6.4.0/function/nvim/mod.ts";

A module to provide functions of Neovim native functions.

import type { Denops } from "https://deno.land/x/denops_std@v6.4.0/mod.ts";
import * as nvimFn from "https://deno.land/x/denops_std@v6.4.0/function/nvim/mod.ts";

export async function main(denops: Denops): Promise<void> {
  // nvimFn holds functions exists only in Neovim
  console.log(nvimFn.api_info(denops));
}

Functions

f api_info	Returns Dictionary of `api-metadata`.
f chanclose	Close a channel or a specific stream associated with it. For a job, {stream} can be one of "stdin", "stdout", "stderr" or "rpc" (closes stdin/stdout for a job started with `"rpc":v:true`) If {stream} is omitted, all streams are closed. If the channel is a pty, this will then close the pty master, sending SIGHUP to the job process. For a socket, there is only one stream, and {stream} should be omitted.
f chansend	Send data to channel {id}. For a job, it writes it to the stdin of the process. For the stdio channel `channel-stdio`, it writes to Nvim's stdout. Returns the number of bytes written if the write succeeded, 0 otherwise. See `channel-bytes` for more information.
f ctxget	Returns a `Dictionary` representing the `context` at {index} from the top of the `context-stack` (see `context-dict`). If {index} is not given, it is assumed to be 0 (i.e.: top).
f ctxpop	Pops and restores the `context` at the top of the `context-stack`.
f ctxpush	Pushes the current editor state (`context`) on the `context-stack`. If {types} is given and is a `List` of `String`s, it specifies which `context-types` to include in the pushed context. Otherwise, all context types are included.
f ctxset	Sets the `context` at {index} from the top of the `context-stack` to that represented by {context}. {context} is a Dictionary with context data (`context-dict`). If {index} is not given, it is assumed to be 0 (i.e.: top).
f ctxsize	Returns the size of the `context-stack`.
f dictwatcheradd	Adds a watcher to a dictionary. A dictionary watcher is identified by three components:
f dictwatcherdel	Removes a watcher added with `dictwatcheradd()`. All three arguments must match the ones passed to `dictwatcheradd()` in order for the watcher to be successfully deleted.
f id	Returns a `String` which is a unique identifier of the container type (`List`, `Dict`, `Blob` and `Partial`). It is guaranteed that for the mentioned types `id(v1) ==# id(v2)` returns true iff `type(v1) == type(v2) && v1 is v2`. Note that `v:_null_string`, `v:_null_list`, `v:_null_dict` and `v:_null_blob` have the same `id()` with different types because they are internally represented as NULL pointers. `id()` returns a hexadecimal representanion of the pointers to the containers (i.e. like `0x994a40`), same as `printf("%p", {expr})`, but it is advised against counting on the exact format of the return value.
f jobpid	Return the PID (process id) of `job-id` {job}.
f jobresize	Resize the pseudo terminal window of `job-id` {job} to {width} columns and {height} rows. Fails if the job was not started with `"pty":v:true`.
f jobstart	Spawns {cmd} as a job. If {cmd} is a List it runs directly (no 'shell'). If {cmd} is a String it runs in the 'shell', like this:
f jobstop	Stop `job-id` {id} by sending SIGTERM to the job process. If the process does not terminate after a timeout then SIGKILL will be sent. When the job terminates its `on_exit` handler (if any) will be invoked. See `job-control`.
f jobwait	Waits for jobs and their `on_exit` handlers to complete.
f menu_get	Returns a `List` of `Dictionaries` describing `menus` (defined by `:menu`, `:amenu`, …), including `hidden-menus`.
f msgpackdump	Convert a list of VimL objects to msgpack. Returned value is a `readfile()`-style list. When {type} contains "B", a `Blob` is returned instead. Example:
f msgpackparse	Convert a `readfile()`-style list or a `Blob` to a list of VimL objects. Example:
f nvim__get_runtime	Find files in runtime directories
f nvim__id	Returns object given as argument.
f nvim__id_array	Returns array given as argument.
f nvim__id_dictionary	Returns dictionary given as argument.
f nvim__id_float	Returns floating-point value given as argument.
f nvim__inspect_cell	NB: if your UI doesn't use hlstate, this will not return hlstate first time.
f nvim__stats	Gets internal stats.
f nvim_buf_add_highlight	Adds a highlight to buffer.
f nvim_buf_attach	Activates buffer-update events on a channel, or as Lua callbacks.
f nvim_buf_call	call a function with buffer as temporary current buffer
f nvim_buf_clear_namespace	Clears `namespace`d objects (highlights, `extmarks`, virtual text) from a region.
f nvim_buf_create_user_command	Creates a buffer-local command `user-commands`.
f nvim_buf_del_extmark	Removes an `extmark`.
f nvim_buf_del_keymap	Unmaps a buffer-local `mapping` for the given mode.
f nvim_buf_del_mark	Deletes a named mark in the buffer. See `mark-motions`.
f nvim_buf_del_user_command	Delete a buffer-local user-defined command.
f nvim_buf_del_var	Removes a buffer-scoped (b:) variable
f nvim_buf_delete	Deletes the buffer. See `:bwipeout`
f nvim_buf_detach	Deactivates buffer-update events on the channel.
f nvim_buf_get_changedtick	Gets a changed tick of a buffer
f nvim_buf_get_commands	Gets a map of buffer-local `user-commands`.
f nvim_buf_get_extmark_by_id	Gets the position (0-indexed) of an `extmark`.
f nvim_buf_get_extmarks	Gets `extmarks` in "traversal order" from a `charwise` region defined by buffer positions (inclusive, 0-indexed `api-indexing`).
f nvim_buf_get_keymap	Gets a list of buffer-local `mapping` definitions.
f nvim_buf_get_lines	Gets a line-range from the buffer.
f nvim_buf_get_mark	Returns a tuple (row,col) representing the position of the named mark. See `mark-motions`.
f nvim_buf_get_name	Gets the full file name for the buffer
f nvim_buf_get_offset	Returns the byte offset of a line (0-indexed). `api-indexing`
f nvim_buf_get_option	Gets a buffer option value
f nvim_buf_get_text	Gets a range from the buffer.
f nvim_buf_get_var	Gets a buffer-scoped (b:) variable.
f nvim_buf_is_loaded	Checks if a buffer is valid and loaded. See `api-buffer` for more info about unloaded buffers.
f nvim_buf_is_valid	Checks if a buffer is valid.
f nvim_buf_line_count	Returns the number of lines in the given buffer.
f nvim_buf_set_extmark	Creates or updates an `extmark`.
f nvim_buf_set_keymap	Sets a buffer-local `mapping` for the given mode.
f nvim_buf_set_lines	Sets (replaces) a line-range in the buffer.
f nvim_buf_set_mark	Sets a named mark in the given buffer, all marks are allowed file/uppercase, visual, last change, etc. See `mark-motions`.
f nvim_buf_set_name	Sets the full file name for a buffer
f nvim_buf_set_option	Sets a buffer option value. Passing `nil` as value deletes the option (only works if there's a global fallback)
f nvim_buf_set_text	Sets (replaces) a range in the buffer
f nvim_buf_set_var	Sets a buffer-scoped (b:) variable
f nvim_call_atomic	Calls many API methods atomically.
f nvim_call_dict_function	Calls a VimL `Dictionary-function` with the given arguments.
f nvim_call_function	Calls a VimL function with the given arguments.
f nvim_chan_send	Send data to channel `id`. For a job, it writes it to the stdin of the process. For the stdio channel `channel-stdio`, it writes to Nvim's stdout. For an internal terminal instance (`nvim_open_term()`) it writes directly to terminal output. See `channel-bytes` for more information.
f nvim_clear_autocmds	Clear all autocommands that match the corresponding {opts}. To delete a particular autocmd, see `nvim_del_autocmd()`.
f nvim_cmd	Executes an Ex command.
f nvim_command	Executes an Ex command.
f nvim_create_augroup	Create or get an autocommand group `autocmd-groups`.
f nvim_create_autocmd	Creates an `autocommand` event handler, defined by `callback` (Lua function or Vimscript function name string) or `command` (Ex command string).
f nvim_create_buf	Creates a new, empty, unnamed buffer.
f nvim_create_namespace	Creates a new namespace or gets an existing one.
f nvim_create_user_command	Creates a global `user-commands` command.
f nvim_del_augroup_by_id	Delete an autocommand group by id.
f nvim_del_augroup_by_name	Delete an autocommand group by name.
f nvim_del_autocmd	Delete an autocommand by id.
f nvim_del_current_line	Deletes the current line.
f nvim_del_keymap	Unmaps a global `mapping` for the given mode.
f nvim_del_mark	Deletes an uppercase/file named mark. See `mark-motions`.
f nvim_del_user_command	Delete a user-defined command.
f nvim_del_var	Removes a global (g:) variable.
f nvim_echo	Echo a message.
f nvim_err_write	Writes a message to the Vim error buffer. Does not append "\n", the message is buffered (won't display) until a linefeed is written.
f nvim_err_writeln	Writes a message to the Vim error buffer. Appends "\n", so the buffer is flushed (and displayed).
f nvim_eval	Evaluates a VimL `expression`. Dictionaries and Lists are recursively expanded.
f nvim_eval_statusline	Evaluates statusline string.
f nvim_exec_autocmds	Execute all autocommands for {event} that match the corresponding {opts} `autocmd-execute`.
f nvim_exec_lua	Execute Lua code. Parameters (if any) are available as `...` inside the chunk. The chunk can return a value.
f nvim_exec2	Executes Vimscript (multiline block of Ex commands), like anonymous `:source`.
f nvim_feedkeys	Sends input-keys to Nvim, subject to various quirks controlled by `mode` flags. This is a blocking call, unlike `nvim_input()`.
f nvim_get_all_options_info	Gets the option information for all options.
f nvim_get_api_info	Returns a 2-tuple (Array), where item 0 is the current channel id and item 1 is the `api-metadata` map (Dictionary).
f nvim_get_autocmds	Get all autocommands that match the corresponding {opts}.
f nvim_get_chan_info	Gets information about a channel.
f nvim_get_color_by_name	Returns the 24-bit RGB value of a `nvim_get_color_map()` color name or "#rrggbb" hexadecimal string.
f nvim_get_color_map	Returns a map of color names and RGB values.
f nvim_get_commands	Gets a map of global (non-buffer-local) Ex commands.
f nvim_get_context	Gets a map of the current editor state.
f nvim_get_current_buf	Gets the current buffer.
f nvim_get_current_line	Gets the current line.
f nvim_get_current_tabpage	Gets the current tabpage.
f nvim_get_current_win	Gets the current window.
f nvim_get_hl	Gets all or specific highlight groups in a namespace.
f nvim_get_hl_id_by_name	Gets a highlight group by name
f nvim_get_keymap	Gets a list of global (non-buffer-local) `mapping` definitions.
f nvim_get_mark	Return a tuple (row, col, buffer, buffername) representing the position of the uppercase/file named mark. See `mark-motions`.
f nvim_get_mode	Gets the current mode. `mode()` "blocking" is true if Nvim is waiting for input.
f nvim_get_namespaces	Gets existing, non-anonymous `namespace`s.
f nvim_get_option	Gets the global value of an option.
f nvim_get_option_info2	Gets the option information for one option from arbitrary buffer or window
f nvim_get_option_value	Gets the value of an option. The behavior of this function matches that of `:set`: the local value of an option is returned if it exists; otherwise, the global value is returned. Local values always correspond to the current buffer or window, unless "buf" or "win" is set in {opts}.
f nvim_get_proc	Gets info describing process `pid`.
f nvim_get_proc_children	Gets the immediate children of process `pid`.
f nvim_get_runtime_file	Find files in runtime directories
f nvim_get_var	Gets a global (g:) variable.
f nvim_get_vvar	Gets a v: variable.
f nvim_input	Queues raw user-input. Unlike `nvim_feedkeys()`, this uses a low-level input buffer and the call is non-blocking (input is processed asynchronously by the eventloop).
f nvim_input_mouse	Send mouse event from GUI.
f nvim_list_bufs	Gets the current list of buffer handles
f nvim_list_chans	Get information about all open channels.
f nvim_list_runtime_paths	Gets the paths contained in 'runtimepath'.
f nvim_list_tabpages	Gets the current list of tabpage handles.
f nvim_list_uis	Gets a list of dictionaries representing attached UIs.
f nvim_list_wins	Gets the current list of window handles.
f nvim_load_context	Sets the current editor state from the given `context` map.
f nvim_notify	Notify the user with a message
f nvim_open_term	Open a terminal instance in a buffer
f nvim_open_win	Open a new window.
f nvim_out_write	Writes a message to the Vim output buffer. Does not append "\n", the message is buffered (won't display) until a linefeed is written.
f nvim_parse_cmd	Parse command line.
f nvim_parse_expression	Parse a VimL expression.
f nvim_paste	Pastes at cursor, in any mode.
f nvim_put	Puts text at cursor, in any mode.
f nvim_replace_termcodes	Replaces terminal codes and `keycodes` (`<CR>`, `<Esc>`, ...) in a string with the internal representation.
f nvim_select_popupmenu_item	Selects an item in the completion popup menu.
f nvim_set_client_info	Self-identifies the client.
f nvim_set_current_buf	Sets the current buffer.
f nvim_set_current_dir	Changes the global working directory.
f nvim_set_current_line	Sets the current line.
f nvim_set_current_tabpage	Sets the current tabpage.
f nvim_set_current_win	Sets the current window.
f nvim_set_decoration_provider	Set or change decoration provider for a `namespace`
f nvim_set_hl	Sets a highlight group.
f nvim_set_hl_ns	Set active namespace for highlights defined with `nvim_set_hl()`. This can be set for a single window, see `nvim_win_set_hl_ns()`.
f nvim_set_hl_ns_fast	Set active namespace for highlights defined with `nvim_set_hl()` while redrawing.
f nvim_set_keymap	Sets a global `mapping` for the given mode.
f nvim_set_option	Sets the global value of an option.
f nvim_set_option_value	Sets the value of an option. The behavior of this function matches that of `:set`: for global-local options, both the global and local value are set unless otherwise specified with {scope}.
f nvim_set_var	Sets a global (g:) variable.
f nvim_set_vvar	Sets a v: variable, if it is not readonly.
f nvim_strwidth	Calculates the number of display cells occupied by `text`. Control characters including `<Tab>` count as one cell.
f nvim_subscribe	Subscribes to event broadcasts.
f nvim_tabpage_del_var	Removes a tab-scoped (t:) variable
f nvim_tabpage_get_number	Gets the tabpage number
f nvim_tabpage_get_var	Gets a tab-scoped (t:) variable
f nvim_tabpage_get_win	Gets the current window in a tabpage
f nvim_tabpage_is_valid	Checks if a tabpage is valid
f nvim_tabpage_list_wins	Gets the windows in a tabpage
f nvim_tabpage_set_var	Sets a tab-scoped (t:) variable
f nvim_ui_attach	Activates UI events on the channel.
f nvim_ui_detach	Deactivates UI events on the channel.
f nvim_ui_pum_set_bounds	Tells Nvim the geometry of the popupmenu, to align floating windows with an external popup menu.
f nvim_ui_pum_set_height	Tells Nvim the number of elements displaying in the popupmenu, to decide `<PageUp>` and `<PageDown>` movement.
f nvim_ui_set_focus	Tells the nvim server if focus was gained or lost by the GUI.
f nvim_ui_set_option	TODO: Documentation
f nvim_ui_try_resize	TODO: Documentation
f nvim_ui_try_resize_grid	Tell Nvim to resize a grid. Triggers a grid_resize event with the requested grid size or the maximum size if it exceeds size limits.
f nvim_unsubscribe	Unsubscribes to event broadcasts.
f nvim_win_call	Calls a function with window as temporary current window.
f nvim_win_close	Closes the window (like `:close` with a `window-ID`).
f nvim_win_del_var	Removes a window-scoped (w:) variable
f nvim_win_get_buf	Gets the current buffer in a window
f nvim_win_get_config	Gets window configuration.
f nvim_win_get_cursor	Gets the (1,0)-indexed, buffer-relative cursor position for a given window (different windows showing the same buffer have independent cursor positions). `api-indexing`
f nvim_win_get_height	Gets the window height
f nvim_win_get_number	Gets the window number
f nvim_win_get_option	Gets a window option value
f nvim_win_get_position	Gets the window position in display cells. First position is zero.
f nvim_win_get_tabpage	Gets the window tabpage
f nvim_win_get_var	Gets a window-scoped (w:) variable
f nvim_win_get_width	Gets the window width
f nvim_win_hide	Closes the window and hide the buffer it contains (like `:hide` with a `window-ID`).
f nvim_win_is_valid	Checks if a window is valid
f nvim_win_set_buf	Sets the current buffer in a window, without side effects
f nvim_win_set_config	Configures window layout. Currently only for floating and external windows (including changing a split window to those layouts).
f nvim_win_set_cursor	Sets the (1,0)-indexed cursor position in the window. `api-indexing` This scrolls the window even if it is not the current one.
f nvim_win_set_height	Sets the window height.
f nvim_win_set_hl_ns	Set highlight namespace for a window. This will use highlights defined with `nvim_set_hl()` for this namespace, but fall back to global highlights (ns=0) when missing.
f nvim_win_set_option	Sets a window option value. Passing `nil` as value deletes the option (only works if there's a global fallback)
f nvim_win_set_var	Sets a window-scoped (w:) variable
f nvim_win_set_width	Sets the window width. This will only succeed if the screen is split vertically.
f reg_recorded	Returns the single letter name of the last recorded register. Returns an empty string when nothing was recorded yet. See `q` and `Q`.
f rpcnotify	Sends {event} to {channel} via `RPC` and returns immediately. If {channel} is 0, the event is broadcast to all channels. Example:
f rpcrequest	Sends a request to {channel} to invoke {method} via `RPC` and blocks until a response is received. Example:
f rpcstart	Deprecated. Replace
f serverstart	Opens a socket or named pipe at {address} and listens for `RPC` messages. Clients can send `API` commands to the returned address to control Nvim.
f serverstop	Closes the pipe or socket at {address}. Returns TRUE if {address} is valid, else FALSE. If `v:servername` is stopped it is set to the next available address in `serverlist()`.
f sockconnect	Connect a socket to an address. If {mode} is "pipe" then {address} should be the path of a local domain socket (on unix) or named pipe (on Windows). If {mode} is "tcp" then {address} should be of the form "host:port" where the host should be an ip adderess or host name, and port the port number.
f stdioopen	With `--headless` this opens stdin and stdout as a `channel`. May be called only once. See `channel-stdio`. stderr is not handled by this function, see `v:stderr`.
f stdpath	Returns `standard-path` locations of various default files and directories.
f termopen	Spawns {cmd} in a new pseudo-terminal session connected to the current (unmodified) buffer. Parameters and behavior are the same as `jobstart()` except "pty", "width", "height", and "TERM" are ignored: "height" and "width" are taken from the current window. Returns the same values as `jobstart()`.
f wait	Waits until {condition} evaluates to `TRUE`, where {condition} is a `Funcref` or `string` containing an expression.

Interfaces

I NvimGetConfigResult
I NvimOpenWinConfig