Liking cljdoc? Tell your friends :D

hive-addon.registry.commands

Command contributions to a composite tool.

An addon contributes named subcommands to a host tool, so analysis command="lint ..." reaches the contributing addon's handler. Each contribution records the contributing addon so shutdown can retract everything that addon added.

Shape: {tool-name {command-name {:handler fn :params {} :description str :addon addon-id}}}

Command contributions to a composite tool.

An addon contributes named subcommands to a host tool, so
`analysis command="lint ..."` reaches the contributing addon's handler.
Each contribution records the contributing addon so shutdown can retract
everything that addon added.

Shape: {tool-name {command-name {:handler fn :params {} :description str
                                 :addon addon-id}}}
raw docstring

clear!clj/s

(clear!)

Remove every contribution. Returns nil.

Remove every contribution. Returns nil.
sourceraw docstring

contribute!clj/s

(contribute! tool-name addon-id commands)

Merge COMMANDS into TOOL-NAME's command tree on behalf of ADDON-ID. Returns the contributed command names.

Merge COMMANDS into TOOL-NAME's command tree on behalf of ADDON-ID.
Returns the contributed command names.
sourceraw docstring

contributed-tool-namesclj/s

(contributed-tool-names)

Every tool name carrying contributions.

Every tool name carrying contributions.
sourceraw docstring

get-commandsclj/s

(get-commands tool-name)

The contributed command tree for TOOL-NAME, or nil.

The contributed command tree for TOOL-NAME, or nil.
sourceraw docstring

retract!clj/s

(retract! tool-name addon-id)

Remove every command ADDON-ID contributed to TOOL-NAME. Returns nil.

Remove every command ADDON-ID contributed to TOOL-NAME. Returns nil.
sourceraw docstring

retract-all!clj/s

(retract-all! addon-id)

Remove every command ADDON-ID contributed to any tool. Returns nil.

Remove every command ADDON-ID contributed to any tool. Returns 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