Liking cljdoc? Tell your friends :D

bareprobe.live

clj

The macro behind live's log-supplying verbs.

The macro behind `live`'s log-supplying verbs.
cljs

Where the effects are: the ambient log, the live page, the request edge, and the one verb that prints. The namespace alias marks the boundary, not the ! suffix. A verb here can read the page without writing it, and core performs no effect at all.

Where the effects are: the ambient log, the live page, the request edge, and the one verb that
prints. The namespace alias marks the boundary, not the `!` suffix. A verb here can read the
page without writing it, and `core` performs no effect at all.
raw docstring

atcljs

(at n)

The record at position n, payload and all.

The record at position `n`, payload and all.
sourceraw docstring

attrscljs

(attrs id)

A map of name to value for the attributes of the element id names, or nil when the id resolves to nothing. An attribute holds what the element was given, not what a control holds now, which props reads.

A map of name to value for the attributes of the element `id` names, or nil when the id
resolves to nothing. An attribute holds what the element was given, not what a control holds
now, which `props` reads.
sourceraw docstring

clear!cljs

(clear!)

Drop everything recorded so far, and forget which answers BareProbe gave. Positions after the clear stay exact, positions before it are gone, and a resource with no traffic after it drops out of state. The log is BareReplay's, so its dock loses the same records.

Drop everything recorded so far, and forget which answers BareProbe gave. Positions after the
clear stay exact, positions before it are gone, and a resource with no traffic after it drops
out of `state`. The log is BareReplay's, so its dock loses the same records.
sourceraw docstring

clear-serving!cljs

(clear-serving!)
(clear-serving! rid)

Drop what is queued, all of it or one resource's. Returns what is left, as serving reads it.

Drop what is queued, all of it or one resource's. Returns what is left, as `serving` reads it.
sourceraw docstring

coveragecljs

(coverage)

What the recorded traffic showed of each resource's declared shape, as {resource-id {…}}. A resource with no installed envelope is absent. :probe/distinct-rows counts rows by the shape's id-key, so paging over the same row twice counts once. It is the denominator that says whether the rest means anything.

What the recorded traffic showed of each resource's declared shape, as {resource-id {…}}. A
resource with no installed envelope is absent. :probe/distinct-rows counts rows by the shape's
id-key, so paging over the same row twice counts once. It is the denominator that says whether
the rest means anything.
sourceraw docstring

defsugarclj/smacro

(defsugar sym & arglists)

Def sym as the bareprobe.core verb of the same name, with the ambient log supplied, one arity per entry in arglists. The docstring is the core verb's own, and the arglists are checked against it.

Def `sym` as the `bareprobe.core` verb of the same name, with the ambient log supplied, one
arity per entry in `arglists`. The docstring is the core verb's own, and the arglists are checked
against it.
sourceraw docstring

diffcljs

(diff n)
(diff a b)

What moved, as {resource-id {key [before after]}}. A resource that did not move is absent. Given one position, what moved in the record there. Given two, what moved between the states at each.

What moved, as {resource-id {key [before after]}}. A resource that did not move is absent. Given
one position, what moved in the record there. Given two, what moved between the states at each.
sourceraw docstring

disagreementscljs

(disagreements)

The positions where a recorded event no longer reproduces its own record. Each names the resource keys that disagree, and the effects as [recorded replayed]. Empty when the log still means what it meant when it was recorded, under the BareBuild on the classpath.

The positions where a recorded event no longer reproduces its own record. Each names the
resource keys that disagree, and the effects as [recorded replayed]. Empty when the log still
means what it meant when it was recorded, under the BareBuild on the classpath.
sourceraw docstring

fault!cljs

(fault! faults)

Arm the request edge, or clear it with nil. Returns what is now armed, and restarts the request count, so a fail-every cycle counts from this call rather than from an earlier one.

(fault! {:latency 800}) every request waits 800ms before it is sent (fault! {:latency 800 :fail-every 3}) and every third one is never sent (fault! nil) restore the decorator installed before

Does not produce a :stale-answer. The runtime never leaves an answer out of step with the request it names.

Arm the request edge, or clear it with nil. Returns what is now armed, and restarts the request
count, so a `fail-every` cycle counts from this call rather than from an earlier one.

  (fault! {:latency 800})                every request waits 800ms before it is sent
  (fault! {:latency 800 :fail-every 3})  and every third one is never sent
  (fault! nil)                           restore the decorator installed before

Does not produce a :stale-answer. The runtime never leaves an answer out of step with the
request it names.
sourceraw docstring

injected?cljs

(injected? row)

A predicate on a summary row: did BareProbe answer the request this row records?

A predicate on a summary row: did BareProbe answer the request this row records?
sourceraw docstring

latestcljs

(latest)

The most recent round trip, with rendered on it under :probe/rendered. The recorded legs are the past and the rendering is the present, which agree only because this is the most recent trip.

The most recent round trip, with `rendered` on it under `:probe/rendered`. The recorded legs are
the past and the rendering is the present, which agree only because this is the most recent
trip.
sourceraw docstring

logcljs

(log)

The recorded entries.

The recorded entries.
sourceraw docstring

propscljs

(props id)

A map of name to value for the properties the element id names declares, or nil when the id resolves to nothing. Names whose property holds anything but a string, number, boolean or nil go under :probe/skipped, and each navigates to what it holds now.

Reads what a control holds now, including text the user typed, which never reaches an attribute. It calls every getter it reads, so a getter that does work does it here. It reads the element's own classes and not the platform's, so innerHTML and the rest of the native surface are absent. An id naming anything but a component is refused, and attrs is what reads one of those.

A map of name to value for the properties the element `id` names declares, or nil when the id
resolves to nothing. Names whose property holds anything but a string, number, boolean or nil go
under `:probe/skipped`, and each navigates to what it holds now.

Reads what a control holds now, including text the user typed, which never reaches an attribute.
It calls every getter it reads, so a getter that does work does it here. It reads the element's
own classes and not the platform's, so `innerHTML` and the rest of the native surface are absent.
An id naming anything but a component is refused, and `attrs` is what reads one of those.
sourceraw docstring

renderedcljs

(rendered rid)

What the consumers of rid show now, as each consumer's id mapped to the custom elements under it, or nil when the resource drives none. Reading stamps a pick id on every element it reports. Every id here is one attrs, props, show! and pick! speak.

What the consumers of `rid` show now, as each consumer's id mapped to the custom elements under
it, or nil when the resource drives none. Reading stamps a pick id on every element it reports.
Every id here is one `attrs`, `props`, `show!` and `pick!` speak.
sourceraw docstring

resourcecljs

(resource rid)
(resource rid n)

What rid held at position n, defaulting to the end of the log. The way in when you want one resource rather than the whole of state.

What `rid` held at position `n`, defaulting to the end of the log. The way in when you want one
resource rather than the whole of `state`.
sourceraw docstring

round-tripscljs

(round-trips)

One value per event and what it caused: what was asked, what was sent, what came back, and the view consumers were handed, each nil where the trip has none. Every record appears in exactly one trip, and a position navigates to the record it names.

One value per event and what it caused: what was asked, what was sent, what came back, and the
view consumers were handed, each nil where the trip has none. Every record appears in exactly one
trip, and a position navigates to the record it names.
sourceraw docstring

serve!cljs

(serve! rid envelope)
(serve! rid envelope {:keys [kind]})

Queue envelope as the answer to the next request for rid. The envelope is the wire form, with string keys, exactly as the server would have sent it. Returns what is queued.

A read and a write carry their request id the same way, so by default whichever arrives first takes the envelope. The trailing directive pins it to one: {:kind :read} or {:kind :write}.

One envelope answers one request and is then spent. Nothing outlives the queue: the wrapper this installs comes off as soon as the last envelope is taken.

Queue `envelope` as the answer to the next request for `rid`. The envelope is the wire form,
with string keys, exactly as the server would have sent it. Returns what is queued.

A read and a write carry their request id the same way, so by default whichever arrives first
takes the envelope. The trailing directive pins it to one: `{:kind :read}` or `{:kind :write}`.

One envelope answers one request and is then spent. Nothing outlives the queue: the wrapper this
installs comes off as soon as the last envelope is taken.
sourceraw docstring

servingcljs

(serving)

What is queued, as {resource-id [{:probe/envelope … :probe/kind …} …]}, or nil when nothing is. The wrapper is installed exactly while this is non-nil.

What is queued, as {resource-id [{:probe/envelope … :probe/kind …} …]}, or nil when nothing is.
The wrapper is installed exactly while this is non-nil.
sourceraw docstring

statecljs

(state)
(state n)

The resources as recorded at position n, and every diagnostic reported up to it. n counts applied events, and defaults to the whole log. Reads what each step left behind rather than replaying to it, so it reports what happened rather than what would happen now.

The resources as recorded at position `n`, and every diagnostic reported up to it. `n` counts
applied events, and defaults to the whole log. Reads what each step left behind rather than
replaying to it, so it reports what happened rather than what would happen now.
sourceraw docstring

statuscljs

(status)

What is recorded, and what is armed at the edge. The request count is what the decorator saw since the faults were last set, a fault-dropped request included.

What is recorded, and what is armed at the edge. The request count is what the decorator saw
since the faults were last set, a fault-dropped request included.
sourceraw docstring

summarycljs

(summary)

One row per record: position, resource id, request id, event key, label, the keys that moved, and the diagnostics. The request id is nil for an event that names no request. round-trips pairs a request with its answer. The event value itself is reachable through at, and through nav.

One row per record: position, resource id, request id, event key, label, the keys that moved,
and the diagnostics. The request id is nil for an event that names no request. `round-trips`
pairs a request with its answer. The event value itself is reachable through `at`, and through
`nav`.
sourceraw docstring

table!cljs

(table!)
(table! rows)
(table! ks rows)

Print rows as an aligned table, one row per line, and return nil. With no arguments, the current log as one line per round trip. ks selects and orders the columns.

Print `rows` as an aligned table, one row per line, and return nil. With no arguments, the
current log as one line per round trip. `ks` selects and orders the columns.
sourceraw docstring

viewcljs

(view n)

The projection the record at position n handed to consumers, or nil when it notified none. A step appends that effect only when the view moved, so nil means nothing was handed over rather than an empty view.

The projection the record at position `n` handed to consumers, or nil when it notified none.
A step appends that effect only when the view moved, so nil means nothing was handed over rather
than an empty view.
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