Liking cljdoc? Tell your friends :D

hive-vim.protocol.schema

HVCP v1 value objects. The bottom layer of hive-vim: every other namespace validates against these, and the tests are synthesized from them.

Host-free cljc. Spec: docs/protocol.md.

HVCP v1 value objects. The bottom layer of hive-vim: every other namespace
validates against these, and the tests are synthesized from them.

Host-free cljc. Spec: docs/protocol.md.
raw docstring

default-timeout-msclj/s

source

dispatch-fnclj/s

The one Vim function every verb is invoked through.

The one Vim function every verb is invoked through.
sourceraw docstring

Envelopeclj/s

What hive#rpc#dispatch returns: exactly one of ok or err.

What hive#rpc#dispatch returns: exactly one of ok or err.
sourceraw docstring

Errclj/s

source

ErrCategoryclj/s

Error categories on the hive side: the wire names under the :vim namespace.

Error categories on the hive side: the wire names under the :vim namespace.
sourceraw docstring

Eventclj/s

source

event-typesclj/s

source

explain-strclj/s

(explain-str schema value)

Humanized explanation of why VALUE does not conform to SCHEMA, or nil.

Humanized explanation of why VALUE does not conform to SCHEMA, or nil.
sourceraw docstring

Frameclj/s

One JSON array on the wire, before or after classification.

One JSON array on the wire, before or after classification.
sourceraw docstring

Helloclj/s

source

hello-timeout-msclj/s

source

HelloReplyclj/s

source

Inboundclj/s

source

max-timeout-msclj/s

source

protocol-versionclj/s

The [major minor] HVCP version this implementation speaks.

The [major minor] HVCP version this implementation speaks.
sourceraw docstring

ProtocolVersionclj/s

source

RequestIdclj/s

Id of a hive -> Vim request. Negative, so it never collides with Vim's own positive message numbers.

Id of a hive -> Vim request. Negative, so it never collides with Vim's own
positive message numbers.
sourceraw docstring

Resultclj/s

source

SessionIdclj/s

source

SessionInfoclj/s

source

Surfaceclj/s

The host contract a verb backs: a hive-spi editor protocol, or hive-addon's ITerminalAddon.

The host contract a verb backs: a hive-spi editor protocol, or hive-addon's
ITerminalAddon.
sourceraw docstring

TimeoutMsclj/s

source

validate!clj/s

(validate! label schema value)

Return VALUE when it conforms to SCHEMA; throw ex-info naming LABEL otherwise.

Return VALUE when it conforms to SCHEMA; throw ex-info naming LABEL otherwise.
sourceraw docstring

VerbSpecclj/s

source

VimMsgIdclj/s

Id of a Vim -> hive request, assigned by Vim.

Id of a Vim -> hive request, assigned by Vim.
sourceraw docstring

wire-err-categoriesclj/s

Error categories as they appear on the wire.

Error categories as they appear on the wire.
sourceraw docstring

WireErrclj/s

source

WireErrCategoryclj/s

source

WireOpclj/s

source

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