Liking cljdoc? Tell your friends :D

hansel.api


instrumentcljmacro

(instrument config form)

A macro for instrumenting a form using hansel.api/instrument-form. Check that one for params docs.

A macro for instrumenting a `form` using `hansel.api/instrument-form`.
Check that one for params docs.
raw docstring

instrument-formclj

(instrument-form config form)

Given any top level form, returns the form instrumented. config should be a map with optional [:trace-form-init :trace-fn-call :trace-fn-return :trace-expr-exec :trace-bind]

Given any top level `form`, returns the form instrumented.
`config` should be a map with optional [:trace-form-init
                                        :trace-fn-call
                                        :trace-fn-return
                                        :trace-expr-exec
                                        :trace-bind]
raw docstring

instrument-namespaces-cljclj

(instrument-namespaces-clj ns-prefixes config)

Instrument entire namespaces. ns-prefixes should be a set of ns name prefixes, like : #{"cljs."}

config should be a map optionally containing all the keys for hansel.api/instrument-form plus :

  • :verbose? true or false to indicate verbose logging
  • :excluding-ns a set of namepsaces names as string to be excluded from instrumentation
  • :excluding-fns a set of fully cualified fn symbols to be excluded from instrumentation

Returns a map with :

  • :inst-fns the set of instrumented fns
  • :affected-namespaces the set of affected namespaces
Instrument entire namespaces.
`ns-prefixes` should be a set of ns name prefixes, like : #{"cljs."}

`config` should be a map optionally containing all the keys for `hansel.api/instrument-form`
plus :
- :verbose? true or false to indicate verbose logging
- :excluding-ns a set of namepsaces names as string to be excluded from instrumentation
- :excluding-fns a set of fully cualified fn symbols to be excluded from instrumentation

Returns a map with :
- :inst-fns the set of instrumented fns
- :affected-namespaces the set of affected namespaces
raw docstring

instrument-namespaces-shadow-cljsclj

(instrument-namespaces-shadow-cljs ns-prefixes {:keys [build-id] :as config})

Instrument entire namespaces for ClojureScript. The arguments are the same as hansel.api/instrument-namespaces-clj plus the config should also contain a :build-id Meant to be used from shadow-cljs clojure repl (not the ClojureScript one)

The :trace-* handlers should be fully qualified symbols of functions in the ClojureScript runtime.

Returns the set of instrumented fns.

Instrument entire namespaces for ClojureScript.
The arguments are the same as `hansel.api/instrument-namespaces-clj` plus
the config should also contain a :build-id
Meant to be used from shadow-cljs clojure repl (not the ClojureScript one)

The :trace-* handlers should be fully qualified symbols of functions in the ClojureScript runtime.

Returns the set of instrumented fns.
raw docstring

instrument-var-cljclj

(instrument-var-clj var-symb config)
(instrument-var-clj var-symb
                    {:keys [deep? uninstrument? skip-namespaces] :as config}
                    *instrumented-set)

Given a Clojure var-symb instrument it using hansel.api/instrument-form. Config options are the same as hansel.api/instrument-form plus

  • :deep? When true recursively instrument all referenced vars (default to false)
  • :skip-namespaces A set of namespaces to skip when instrumenting deeply.
Given a Clojure `var-symb` instrument it using `hansel.api/instrument-form`.
Config options are the same as `hansel.api/instrument-form` plus
- :deep? When true recursively instrument all referenced vars (default to false)
- :skip-namespaces A set of namespaces to skip when instrumenting deeply.
raw docstring

instrument-var-shadow-cljsclj

(instrument-var-shadow-cljs var-symb config)
(instrument-var-shadow-cljs
  var-symb
  {:keys [build-id deep? uninstrument? skip-namespaces] :as config}
  *instrumented-set)

Instrument a var for ClojureScript. The arguments are the same as hansel.api/instrument-var-clj plus the config should also contain a :build-id Meant to be used from shadow-cljs clojure repl (not the ClojureScript one)

The :trace-* handlers should be fully qualified symbols of functions in the ClojureScript runtime.

Instrument a var for ClojureScript.
The arguments are the same as `hansel.api/instrument-var-clj` plus
the config should also contain a :build-id
Meant to be used from shadow-cljs clojure repl (not the ClojureScript one)

The :trace-* handlers should be fully qualified symbols of functions in the ClojureScript runtime.
raw docstring

uninstrument-namespaces-cljclj

(uninstrument-namespaces-clj ns-prefixes)
(uninstrument-namespaces-clj ns-prefixes config)

Uninstrument namespaces instrumented by hansel.api/instrument-namespaces-clj ns-prefixes should be a set of namespaces prefixes as string.

Uninstrument namespaces instrumented by `hansel.api/instrument-namespaces-clj`
`ns-prefixes` should be a set  of namespaces prefixes as string.
raw docstring

uninstrument-namespaces-shadow-cljsclj

(uninstrument-namespaces-shadow-cljs ns-prefixes config)

Uninstrument namespaces instrumented by hansel.api/instrument-namespaces-shadow-cljs

Uninstrument namespaces instrumented by `hansel.api/instrument-namespaces-shadow-cljs`
raw docstring

uninstrument-var-cljclj

(uninstrument-var-clj var-symb)
(uninstrument-var-clj var-symb config)

Uninstrument a Clojure var-symb instrumented by hansel.api/instrument-var-clj

Uninstrument a Clojure `var-symb` instrumented by `hansel.api/instrument-var-clj`
raw docstring

uninstrument-var-shadow-cljsclj

(uninstrument-var-shadow-cljs var-symb config)

Uninstrument vars instrumented by hansel.api/instrument-var-shadow-cljs

Uninstrument vars instrumented by `hansel.api/instrument-var-shadow-cljs`
raw docstring

with-ctxcljmacro

(with-ctx ctx & body)

Run body binding hansel.instrument.runtime/*runtime-ctx* to ctx

Run `body` binding `hansel.instrument.runtime/*runtime-ctx*` to `ctx`
raw docstring

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

× close