Liking cljdoc? Tell your friends :D

hive-vim.addon

Canonical hive-addon boundary for hive-vim (manifest id hive.vim): a hive-vessel vessel IAddon.

Construction is pure. initialize! starts the HVCP transport, registers the :vim editor port, builds the :vim terminal backend and the vessel registry: hive-vessel's standard translators plus the :vessel/translators hook of every dependency the mount hands over under :mount/dependencies.

What other addons use is contributed through hooks (see hook-keys); nothing here names a host or a sibling addon. shutdown! reverses all of it.

Canonical hive-addon boundary for hive-vim (manifest id hive.vim): a
hive-vessel vessel IAddon.

Construction is pure. initialize! starts the HVCP transport, registers the
:vim editor port, builds the :vim terminal backend and the vessel registry:
hive-vessel's standard translators plus the :vessel/translators hook of every
dependency the mount hands over under :mount/dependencies.

What other addons use is contributed through hooks (see `hook-keys`);
nothing here names a host or a sibling addon. shutdown! reverses all of it.
raw docstring

addon-ctorclj

(addon-ctor config)

Pure hive-addon.mount constructor: config -> uninitialized IAddon.

Pure hive-addon.mount constructor: config -> uninitialized IAddon.
sourceraw docstring

addon-id-valueclj

source

default-port-fileclj

source

hook-keysclj

Hooks an active hive.vim contributes. Each value is a fn.

:vessel/target (fn []) hive-vessel target for Vim :vessel/instance (fn []) hive-addon IVessel (:editor :terminal) :vessel/dispatch! (fn [op-or-ops]) plan and run ops on Vim :vessel/register-translators! (fn [translators]) extend this vessel's registry :vim/editor-port (fn []) hive-spi editor port :vim/terminal (fn []) ITerminalAddon running lings in Vim :vim/register-listener! (fn [id f]) receive (f event payload) for :vim/connected :vim/event :vim/disconnected :vim/unregister-listener! (fn [id])

Hooks an active hive.vim contributes. Each value is a fn.

:vessel/target                (fn [])            hive-vessel target for Vim
:vessel/instance              (fn [])            hive-addon IVessel (:editor :terminal)
:vessel/dispatch!             (fn [op-or-ops])   plan and run ops on Vim
:vessel/register-translators! (fn [translators]) extend this vessel's registry
:vim/editor-port              (fn [])            hive-spi editor port
:vim/terminal                 (fn [])            ITerminalAddon running lings in Vim
:vim/register-listener!       (fn [id f])        receive (f event payload) for
                                                 :vim/connected :vim/event :vim/disconnected
:vim/unregister-listener!     (fn [id])
sourceraw docstring

make-addonclj

(make-addon)
(make-addon seed)

An uninitialized IAddon. No socket, file or registry mutation.

An uninitialized IAddon. No socket, file or registry mutation.
sourceraw docstring

serverclj

(server addon)

The running transport of ADDON, or nil.

The running transport of ADDON, or nil.
sourceraw docstring

terminalclj

(terminal addon)

The VimTerminal of an initialized ADDON, or nil.

The VimTerminal of an initialized ADDON, or nil.
sourceraw docstring

vesselclj

(vessel addon)

The Vim vessel descriptor of an initialized ADDON, or nil.

The Vim vessel descriptor of an initialized ADDON, or nil.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close