Liking cljdoc? Tell your friends :D

hive-tmux.vessel-target

The hive-vessel target of this addon: :text natives executed through the tmux CLI by hive-vessel.executor.tmux, on the session the python bridge drives.

Strata: target-opts is the pure Promote step (addon config -> executor opts); target is the Boundary that hands those opts to hive-vessel's executor; hooks-for is the addon-facing projection, resolved per call so a consumer holding the hook sees nil once the addon is shut down.

The hive-vessel target of this addon: :text natives executed through the
tmux CLI by hive-vessel.executor.tmux, on the session the python bridge
drives.

Strata: `target-opts` is the pure Promote step (addon config -> executor
opts); `target` is the Boundary that hands those opts to hive-vessel's
executor; `hooks-for` is the addon-facing projection, resolved per call so
a consumer holding the hook sees nil once the addon is shut down.
raw docstring

Configclj

The slice of the addon's runtime config the target reads. Every key is optional and nil means unset, so a host that passes its whole config map through is accepted.

The slice of the addon's runtime config the target reads. Every key is
optional and nil means unset, so a host that passes its whole config map
through is accepted.
sourceraw docstring

default-sessionclj

The tmux session panels open in when the config names none: the one the python bridge creates (tmux new-session -d -s hive).

The tmux session panels open in when the config names none: the one the
python bridge creates (`tmux new-session -d -s hive`).
sourceraw docstring

hooks-forclj

(hooks-for state)

The hook contributions of an addon whose lifecycle lives in the STATE atom ({:initialized? bool :config map}): the target under target-hook-key while initialized, {} otherwise. The hook fn re-reads STATE on every call, so a consumer that kept the fn gets nil after shutdown instead of a target for a server nobody drives.

The hook contributions of an addon whose lifecycle lives in the STATE atom
({:initialized? bool :config map}): the target under `target-hook-key`
while initialized, {} otherwise. The hook fn re-reads STATE on every call,
so a consumer that kept the fn gets nil after shutdown instead of a target
for a server nobody drives.
sourceraw docstring

targetclj

(target)
(target config)
(target config ports)

A hive-vessel target for this tmux: {:vessel/id :tmux :vessel/dialect :text :vessel/execute! f}. CONFIG is the addon config (see Config); PORTS may carry :run!, the tmux port hive-vessel's executor calls instead of the binary, which is how a test observes the executor without a tmux server.

A hive-vessel target for this tmux: {:vessel/id :tmux :vessel/dialect :text
:vessel/execute! f}. CONFIG is the addon config (see `Config`); PORTS may
carry :run!, the tmux port hive-vessel's executor calls instead of the
binary, which is how a test observes the executor without a tmux server.
sourceraw docstring

target-hook-keyclj

The hook key under which an active addon offers its target: a 0-arity fn returning the descriptor, or nil once shut down. The same key hive-emacs and hive-vscode use, so a consumer asks every editor addon one question.

The hook key under which an active addon offers its target: a 0-arity fn
returning the descriptor, or nil once shut down. The same key hive-emacs
and hive-vscode use, so a consumer asks every editor addon one question.
sourceraw docstring

target-optsclj

(target-opts config)

Executor opts from the addon CONFIG. The session defaults to default-session; every other key is passed through only when set.

Executor opts from the addon CONFIG. The session defaults to
`default-session`; every other key is passed through only when set.
sourceraw docstring

TargetOptsclj

What hive-vessel.executor.tmux/target accepts from this addon. Closed: a config key that is not one of these never reaches the executor.

What hive-vessel.executor.tmux/target accepts from this addon. Closed: a
config key that is not one of these never reaches the executor.
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