Liking cljdoc? Tell your friends :D

scicloj.kindly.v4.api

See the kind namespace

See the kind namespace
raw docstring

*prefer-kinds*clj/s

When bound to true, prefer returning Kindly-annotated values rather than launching external viewers or tools. Tools that view kinds (like Clay) will bind to true. Libraries and user code can use this to know that the tool is already running.

When bound to true, prefer returning Kindly-annotated values
rather than launching external viewers or tools.
Tools that view kinds (like Clay) will bind to true.
Libraries and user code can use this to know that the tool is already running.
raw docstring

attach-kind-to-valueclj/s

(attach-kind-to-value value kind)

attach-meta-to-valueclj/s

(attach-meta-to-value value m)

checkclj/s

(check & args)

Add a generated test using :kind/test-last

Add a generated test using `:kind/test-last`
raw docstring

considerclj/s

(consider value m)

Add metadata to a given value. A values which cannot have metadata (i.e., is not an instance of IObj) is wrapped in a vector first

Add metadata to a given value.
A values which cannot have metadata
(i.e., is not an instance of `IObj`)
is wrapped in a vector first
raw docstring

deep-mergeclj/s

(deep-merge)
(deep-merge a)
(deep-merge a b)
(deep-merge a b & more)

Recursively merges values with support for control metadata. Merge rules:

  • Maps are merged recursively
  • Non-maps except nil replace previous value
  • ^:replace on a map replaces previous value Examples: (deep-merge {:a 1} {:a 2}) => {:a 2} (deep-merge {:a 1} ^:replace {:b 2}) => {:b 2}
Recursively merges values with support for control metadata.
Merge rules:
- Maps are merged recursively
- Non-maps except nil replace previous value
- ^:replace on a map replaces previous value
Examples:
(deep-merge {:a 1} {:a 2}) => {:a 2}
(deep-merge {:a 1} ^:replace {:b 2}) => {:b 2}
raw docstring

get-optionsclj/s

(get-options)

hide-codeclj/s

(hide-code value)
(hide-code value bool)

Annotate whether the code of this value should be hidden

Annotate whether the code of this value should be hidden
raw docstring

known-kindsclj/s

A set of common visualization requests

A set of common visualization requests
raw docstring

merge-options!clj/s

(merge-options! options)

Mutates options with the deep merge of options

Mutates *options* with the deep merge of options
raw docstring

set-options!clj/s

(set-options! options)

Replaces options with options

Replaces *options* with options
raw 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