Liking cljdoc? Tell your friends :D

hive-compose.schema

Value objects: Profile, Active entry, Settings, Release step.

Value objects: Profile, Active entry, Settings, Release step.
raw docstring

Activeclj

A profile this addon brought up (or adopted) and still answers for. :profile is the Profile it ran with, so it can be released after leaving the config. :needs is the depends_on closure of :services when it is wider (a section started with no-deps, an adopted one); release spares what any other entry needs. :programs are the host programs it holds, by program id.

A profile this addon brought up (or adopted) and still answers for. `:profile`
is the Profile it ran with, so it can be released after leaving the config.
`:needs` is the depends_on closure of `:services` when it is wider (a section
started with no-deps, an adopted one); release spares what any other entry
needs. `:programs` are the host programs it holds, by program id.
sourceraw docstring

ActiveMapclj

source

explainclj

(explain schema v)

nil when v conforms to schema, else humanized problems.

nil when `v` conforms to `schema`, else humanized problems.
sourceraw docstring

IdleActionclj

What the reaper does to an idle profile. :stop keeps containers, :down removes them (never volumes), :none exempts the profile.

What the reaper does to an idle profile. :stop keeps containers, :down removes
them (never volumes), :none exempts the profile.
sourceraw docstring

Profileclj

source

ProfileIdclj

A preset name, or a section id <project>/<target>[+<target>..].

A preset name, or a section id `<project>/<target>[+<target>..]`.
sourceraw docstring

Programclj

A host process a section needs beside its containers. :program/with pairs it with compose services: it starts with a section running one of them, or with every section of its project when it names none. A directory with a Clojure build file needs no :program/command: the command and the nREPL port are derived from it (see hive-compose.promote.program).

A host process a section needs beside its containers. `:program/with` pairs
it with compose services: it starts with a section running one of them, or
with every section of its project when it names none. A directory with a
Clojure build file needs no `:program/command`: the command and the nREPL
port are derived from it (see `hive-compose.promote.program`).
sourceraw docstring

Projectclj

Where a compose project lives. Its YAML is the source of truth: sections are resolved from its services, native profiles and depends_on. :project/programs are the host programs its sections start beside their containers.

Where a compose project lives. Its YAML is the source of truth: sections are
resolved from its services, native profiles and depends_on. `:project/programs`
are the host programs its sections start beside their containers.
sourceraw docstring

Releaseclj

One step of a plan: act on services of project on behalf of a profile.

One step of a plan: act on `services` of `project` on behalf of a profile.
sourceraw docstring

Runningclj

A started Program: the pid leading its process group, where its output goes and, for a Clojure kind, the nREPL port to connect to.

A started Program: the pid leading its process group, where its output goes
and, for a Clojure kind, the nREPL port to connect to.
sourceraw docstring

Settingsclj

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