Liking cljdoc? Tell your friends :D

ghostwheel.core


*global-check-allowed?*clj/s

source

*global-trace-allowed?*clj/s

source

<-clj/s

source

=>clj/s

source

>defnclj/s≠macro

clj
(>defn name
       doc-string?
       attr-map?
       ([params*] gspec prepost-map? body?)
       +
       attr-map?)
(>defn name doc-string? attr-map? [params*] gspec prepost-map? body?)
cljs
(>defn & forms)

Like defn, but requires a (nilable) gspec definition and generates additional s/fdef, generative tests, instrumentation code, an fspec-based stub, and/or tracing code, depending on the configuration metadata and the existence of a valid gspec and non-nil body.

Like defn, but requires a (nilable) gspec definition and generates
additional `s/fdef`, generative tests, instrumentation code, an
fspec-based stub, and/or tracing code, depending on the configuration
metadata and the existence of a valid gspec and non-nil body.
source (clj)source (cljs)raw docstring

>defn-clj/s≠macro

clj
(>defn- name
        doc-string?
        attr-map?
        ([params*] gspec prepost-map? body?)
        +
        attr-map?)
(>defn- name doc-string? attr-map? [params*] gspec prepost-map? body?)
cljs
(>defn- & forms)

Like defn-, but requires a (nilable) gspec definition and generates additional s/fdef, generative tests, instrumentation code, an fspec-based stub, and/or tracing code, depending on the configuration metadata and the existence of a valid gspec and non-nil body.

Like defn-, but requires a (nilable) gspec definition and generates
additional `s/fdef`, generative tests, instrumentation code, an
fspec-based stub, and/or tracing code, depending on the configuration
metadata and the existence of a valid gspec and non-nil body.
source (clj)source (cljs)raw docstring

>fdefclj/s≠macro

clj
(>fdef name [params*] gspec)
(>fdef name ([params*] gspec) +)
cljs
(>fdef & forms)

Defines an fspec using gspec syntax – pretty much a >defn without the body.

name can be a symbol or a qualified keyword, depending on whether the fspec is meant to be registered as a top-level fspec (=> s/fdef fn-sym ...) or used in other specs (=> s/def ::spec-keyword (s/fspec ...)).

When defining global fspecs, instrumentation can be directly enabled by setting the ^::g/instrument or ^::g/outstrument metadata on the symbol.

Defines an fspec using gspec syntax – pretty much a `>defn` without the body.

`name` can be a symbol or a qualified keyword, depending on whether the
fspec is meant to be registered as a top-level fspec (=> s/fdef fn-sym
...) or used in other specs (=> s/def ::spec-keyword (s/fspec ...)).

When defining global fspecs, instrumentation can be directly enabled by
setting the `^::g/instrument` or `^::g/outstrument` metadata on the symbol.
source (clj)source (cljs)raw docstring

?clj/smacro

(? & forms)
source (clj)source (cljs)

after-checkclj/smacro

(after-check & callbacks)

Takes a number of 0-arity functions to run after all checks are completed successfully.

Meant to be used in a hot-reloading environment by putting it at the bottom of a (g/check)-ed namespace and calling ghostwheel.core/after-check-async correctly in the build system post-reload hooks.

Takes a number of 0-arity functions to run
after all checks are completed successfully.

Meant to be used in a hot-reloading environment by putting it at the bottom
of a `(g/check)`-ed namespace and calling `ghostwheel.core/after-check-async`
correctly in the build system post-reload hooks.
source (clj)source (cljs)raw docstring

after-check-asyncclj/s

(after-check-async done)
source

checkclj/s≠macro

clj
(check)
(check ns-regex-or-quoted-ns-or-fn)
(check [ns-regex-or-quoted-ns-or-fn+])
cljs
(check)
(check things)

Runs Ghostwheel checks on the given namespaces and/or functions. Checks the current namespace if called without arguments.

Runs Ghostwheel checks on the given namespaces and/or functions.
Checks the current namespace if called without arguments.
source (clj)source (cljs)raw docstring

disable-check!clj/s

(disable-check!)
source

disable-trace!clj/s

(disable-trace!)
source

enable-check!clj/s

(enable-check!)
source

enable-trace!clj/s

(enable-trace!)
source

threading-macro-symsclj/s

source

trclj/smacro

(tr expr)

Alias for |>

Alias for |>
source (clj)source (cljs)raw docstring

|clj/s

source

|>clj/smacro

(|> expr)

Traces or logs+returns the wrapped expression, depending on its type

Traces or logs+returns the wrapped expression, depending on its type
source (clj)source (cljs)raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close