# Packages
Package plugin is a Nvim remote plugin host.
# Functions
ChildProcessArgs specifies the command line arguments.
ChildProcessCommand specifies the command to run.
ChildProcessContext specifies the context to use when starting the command.
ChildProcessDir specifies the working directory for the process.
ChildProcessEnv specifies the environment for the child process.
ChildProcessLogf specifies function for logging output.
ChildProcessServe specifies whether Server should be run in a goroutine.
Dial dials an Nvim instance given an address in the format used by $NVIM_LISTEN_ADDRESS.
DialContext specifies the context to use when starting the command.
DialLogf specifies function for logging output.
DialNetDial specifies a function used to dial a network connection.
DialServe specifies whether Server should be run in a goroutine.
New creates an Nvim client.
NewBufferReader returns a reader for the specified buffer.
NewChildProcess returns a client connected to stdin and stdout of a new child process.
NewEmbedded starts an embedded instance of Nvim using the specified options.
# Constants
BinaryName is the name of default nvim binary name.
BorderStyleDouble a double line box.
BorderStyleNone is the no border.
BorderStyleRounded like "single", but with rounded corners ("╭" etc.).
BorderStyleShadow a drop shadow effect by blending with the background.
BorderStyleSingle is a single line box.
BorderStyleSolid adds padding by a single whitespace cell.
ClientAttributeKeyLicense Informal description of the license, such as "Apache 2", "GPLv3" or "MIT".
ClientAttributeKeyWebsite Website of client (for instance github repository).
ClientoAttributeKeyLogo URI or path to image, preferably small logo or icon.
EmbedderClientType for the application using nvim as a component, for instance IDE/editor implementing a vim mode.
EventBufChangedtick event name of "nvim_buf_changedtick_event".
EventBufDetach event name of "nvim_buf_detach_event".
EventBufLines event name of "nvim_buf_lines_event".
list of OptionValueScope.
HostClientType for the plugin host.
list of OptionValueScope.
list of LogLevels.
list of LogLevels.
list of LogLevels.
list of LogLevels.
list of LogLevels.
PluginClientType for the single plugin.
RemoteClientType for the client library.
UIClientType for the gui frontend.
# Structs
Batch collects API function calls and executes them atomically.
BatchError represents an error from a API function call in a Batch.
BufDetachEvent represents a EventBufDetach type.
BufLinesEvent represents a EventBufLines type.
ChangedtickEvent represents a EventBufChangedtick type.
Channel information about a channel.
ChildProcessOption specifies an option for creating a child process.
Client represents a identify the client for nvim.
ClientMethod builtin methods in the client.
ClientMethodNArgs is the number of arguments.
ClientVersion represents a version of client for nvim.
Command represents a Neovim Ex command.
CommandCompletionArgs represents the arguments to a custom command line completion function.
DialOption specifies an option for dialing to Nvim.
EmbedOptions specifies options for starting an embedded instance of Nvim.
ExtMark represents a extmarks type.
HLAttrs represents a highlight definitions.
Mapping represents a nvim mapping options.
Mark represents a mark.
Mode represents a Nvim's current mode.
Nvim represents a remote instance of Nvim.
OptionInfo represents a option information.
Process represents a Proc and ProcChildren functions return type.
QuickfixError represents an item in a quickfix list.
TextChunk represents a text chunk.
UI represents a nvim ui options.
UserLuaCommand is a user Lua command executed at UserCommand.
WindowConfig represents a configs of OpenWindow.
# Interfaces
UserCommand represesents a user command.
# Type aliases
BorderStyle represents a WindowConfig.Border style.
Buffer represents a Nvim buffer.
ClientAttributes informal attributes describing the client.
ClientType type of client information.
ErrorList is a list of errors.
LogLevel represents a nvim log level.
OptionValueScope represents a OptionValue scope optional parameter value.
Tabpage represents a Nvim tabpage.
UserVimCommand is a user Vim command executed at UserCommand.
Window represents a Nvim window.