View vocabulary and JSON Schema validation.
View vocabulary and JSON Schema validation.
(answer-error fields answer)nil when answer is valid for fields, otherwise a reason.
nil when `answer` is valid for `fields`, otherwise a reason.
Wire button action to internal action.
Wire button action to internal action.
Wire button variant to internal variant.
Wire button variant to internal variant.
Every key a field answered from :options may carry.
Every key a field answered from `:options` may carry.
Answer field types carrying choices.
Answer field types carrying choices.
Wire names of the pictures that a diff toolbar command can show.
Wire names of the pictures that a diff toolbar command can show.
Wire component name to internal type, for every component in the catalog.
Wire component name to internal type, for every component in the catalog.
(decoration? {:keys [type]})True when this normalized node is a display, data or action component. It holds no answer, so every surface asks this before it looks for a value, and the answer contract never sees such a node.
True when this normalized node is a display, data or action component. It holds no answer, so every surface asks this before it looks for a value, and the answer contract never sees such a node.
Keys the ENGINE stamps on a normalized node, never written in a spec.
:is-secret follows from the type, so a caller offering it is refused.
Keys the ENGINE stamps on a normalized node, never written in a spec. `:is-secret` follows from the type, so a caller offering it is refused.
(error-card id text)The node that a host shows in place of node id with fault text.
The node that a host shows in place of node `id` with fault `text`.
(field-error field)nil when field is a valid normalized answer field, otherwise a reason.
nil when `field` is a valid normalized answer field, otherwise a reason.
Every key a field spec may be WRITTEN with: the union of the per-type sets, less what the engine derives. The parser accepts exactly this vocabulary in its snake_case spelling, so there is no second table of keys to keep in step.
Every key a field spec may be WRITTEN with: the union of the per-type sets, less what the engine derives. The parser accepts exactly this vocabulary in its snake_case spelling, so there is no second table of keys to keep in step.
Wire answer-field name to internal field type.
Wire answer-field name to internal field type.
(fill-live-node node)Live wire node node with the defaults that every host fills: a null key is an
absent key, a node without a type is a plaintext input, an input takes its name
and label from its id, a link with a scheme is a url link, and each required key
with a schema default takes it. The children of a group are filled too.
Live wire node `node` with the defaults that every host fills: a null key is an absent key, a node without a type is a `plaintext` input, an input takes its name and label from its id, a link with a scheme is a `url` link, and each required key with a schema `default` takes it. The children of a group are filled too.
Bounds of a grid group's max_columns: [minimum maximum].
Bounds of a grid group's `max_columns`: `[minimum maximum]`.
Wire layout direction to internal direction.
Wire layout direction to internal direction.
(group-error group)nil when group is a valid normalized layout group, otherwise a reason.
nil when `group` is a valid normalized layout group, otherwise a reason.
Every key a layout group may carry. A node that holds no answer has no key that describes one.
Every key a layout group may carry. A node that holds no answer has no key that describes one.
The keyed collection each live node type holds: which key carries it, and how many items it may hold before a patch is REFUSED. One table, so the materializer, the refusal message and the contract document all read it.
The keyed collection each live node type holds: which key carries it, and how many items it may hold before a patch is REFUSED. One table, so the materializer, the refusal message and the contract document all read it.
The keys only a group has. A field carrying one meant to group and forgot to say so, which is worth its own message rather than an unknown-key refusal.
The keys only a group has. A field carrying one meant to group and forgot to say so, which is worth its own message rather than an unknown-key refusal.
Wire link target name to internal target type.
Wire link target name to internal target type.
Wire table alignment to internal alignment.
Wire table alignment to internal alignment.
(live-artifact-error artifact)nil when artifact is a valid settled live artifact, otherwise a reason.
nil when `artifact` is a valid settled live artifact, otherwise a reason.
Byte size under which a settled view ALSO travels inline, on top of the file it
already points at (256 KiB — the same floor
attachment-storage/default-offload-floor-bytes uses to decide that a small
payload never earns an external round-trip; stated here because the View
contract may not drag the imaging stack in to read it).
A view this small survives a session sync to another machine; a build log does not, and must not — holding one in memory as base64 is the cost this whole phase exists to remove.
Byte size under which a settled view ALSO travels inline, on top of the file it already points at (256 KiB — the same floor `attachment-storage/default-offload-floor-bytes` uses to decide that a small payload never earns an external round-trip; stated here because the View contract may not drag the imaging stack in to read it). A view this small survives a session sync to another machine; a build log does not, and must not — holding one in memory as base64 is the cost this whole phase exists to remove.
Every key a settled view carries as an ARTIFACT: what it WAS (:view-id,
:session-id, :title), how it ENDED (:ended-at, :reason), what a surface
opens instantly (:view, the final materialized state) and where the bytes are
(:storage-uri, :size, :line-count, and :base64 only under
live-artifact-inline-bytes).
Every key a settled view carries as an ARTIFACT: what it WAS (`:view-id`, `:session-id`, `:title`), how it ENDED (`:ended-at`, `:reason`), what a surface opens instantly (`:view`, the final materialized state) and where the bytes are (`:storage-uri`, `:size`, `:line-count`, and `:base64` only under [[live-artifact-inline-bytes]]).
Media type for the append-only live-view record.
Media type for the append-only live-view record.
Every key one declared table column may carry.
Every key one declared table column may carry.
Every key a layout group may carry, in a form and in a live view. Nested groups use their own available width in each client.
No :name: a group holds no answer, so there is nothing to key.
Every key a layout group may carry, in a form and in a live view. Nested groups use their own available width in each client. No `:name`: a group holds no answer, so there is nothing to key.
Collection key to the schema default of each required key of one item.
Collection key to the schema default of each required key of one item.
Every key one timeline lane may carry.
Every key one timeline lane may carry.
Wire live component name to the schema default of each required key. The schema is the one owner of these defaults: every host fills them from here.
Wire live component name to the schema default of each required key. The schema is the one owner of these defaults: every host fills them from here.
(live-node-error node)nil when node is a valid normalized live node, otherwise a reason.
nil when `node` is a valid normalized live node, otherwise a reason.
(live-node-fault node decl?)The fault text of one wire node, or nil when it is valid.
The fault text of one wire node, or nil when it is valid.
(live-node-lines node decl?)The sorted fault lines of wire node node after fill-live-node, or an empty
vector. A line names the path in the node, the broken rule and its keyword, never a
value. With decl?, a key that only the host writes is a fault. The faults of a
group child belong to the child, which the caller checks on its own.
The sorted fault lines of wire node `node` after [[fill-live-node]], or an empty vector. A line names the path in the node, the broken rule and its keyword, never a value. With `decl?`, a key that only the host writes is a fault. The faults of a group child belong to the child, which the caller checks on its own.
Wire live component name to the keys that its own schema variant allows.
Wire live component name to the keys that its own schema variant allows.
Wire display, data and action component name to internal type.
Wire display, data and action component name to internal type.
Allowed keys for each patch operation.
Allowed keys for each patch operation.
Every key any patch operation may carry — the union the parser derives its snake_case spellings from.
Every key any patch operation may carry — the union the parser derives its snake_case spellings from.
(live-op-target-lines node-type node-id op)The sorted fault lines of wire op op on a node of wire type node-type: the op
does not apply to that type, or a key of the op that the type does not take. Every
host checks this before it applies a node op. An op without a target table has no lines.
A thread op on a thread node must name the id node-id of that node.
The sorted fault lines of wire op `op` on a node of wire type `node-type`: the op does not apply to that type, or a key of the op that the type does not take. Every host checks this before it applies a node op. An op without a target table has no lines. A thread op on a thread node must name the id `node-id` of that node.
Wire live patch operation to internal operation.
Wire live patch operation to internal operation.
Wire table order to internal order.
Wire table order to internal order.
(live-patch-error patch)nil when patch has a valid live patch shape, otherwise a reason.
nil when `patch` has a valid live patch shape, otherwise a reason.
(live-patch-lines patch)The sorted fault lines of live patch patch, which every host gives before it applies
an op. The patch keys and the op list are checked with a stand-in op, and each op on
its own, so a fault of one op never hides the faults of the patch. An item gets its
schema defaults first.
The sorted fault lines of live patch `patch`, which every host gives before it applies an op. The patch keys and the op list are checked with a stand-in op, and each op on its own, so a fault of one op never hides the faults of the patch. An item gets its schema defaults first.
(live-patched-lines lines-of before after)The fault lines of after whose path and rule before did not have: a patch is
refused only for a fault that it adds, not for one that it makes smaller or larger.
lines-of is live-view-lines or a node check.
The fault lines of `after` whose path and rule `before` did not have: a patch is refused only for a fault that it adds, not for one that it makes smaller or larger. `lines-of` is [[live-view-lines]] or a node check.
Keys returned in a finished live-view picture.
Keys returned in a finished live-view picture.
Wire settlement reason to internal reason.
Wire settlement reason to internal reason.
(live-result-error result)nil when result is a valid live result, otherwise a reason.
nil when `result` is a valid live result, otherwise a reason.
Keys in the result returned to the model.
Keys in the result returned to the model.
Every key one table row may carry.
Every key one table row may carry.
Every key one scene mesh may carry.
Every key one scene mesh may carry.
Every key one scene object may carry.
Every key one scene object may carry.
Maximum serialized archive-only selection pictures in one live record trailer.
Maximum serialized archive-only selection pictures in one live record trailer.
(live-shortcuts-error view)nil when the shortcuts of normalized live view view pass the shared shortcut
rules of live-view-faults, otherwise the view fault text.
nil when the shortcuts of normalized live view `view` pass the shared shortcut rules of [[live-view-faults]], otherwise the view fault text.
Wire sort direction to internal direction.
Wire sort direction to internal direction.
Every key a {:by …} table order may carry.
Every key a `{:by …}` table order may carry.
Every key one declared table group may carry: the id rows point at, the label a surface paints instead of that id, a tone for the head, where the group sorts, and whether it starts open.
Every key one declared table group may carry: the id rows point at, the label a surface paints instead of that id, a tone for the head, where the group sorts, and whether it starts open.
(live-view-error view)nil when normalized live view view passes live-view-faults, otherwise the
view fault text, or the fault text of its first broken node.
nil when normalized live view `view` passes [[live-view-faults]], otherwise the view fault text, or the fault text of its first broken node.
(live-view-faults view decl?)Check live wire view view as every host does. Answers {:view lines :nodes {id text} :dropped notes}. A line of live-view-lines refuses the whole view.
Else each node that breaks its own rules maps its id to its fault text, and a host
shows it as an error card. A shortcut that names such a node is dropped, with one
note each.
Check live wire view `view` as every host does. Answers `{:view lines :nodes
{id text} :dropped notes}`. A line of [[live-view-lines]] refuses the whole view.
Else each node that breaks its own rules maps its id to its fault text, and a host
shows it as an error card. A shortcut that names such a node is dropped, with one
note each.Every key a live view may carry, engine stamps included.
Every key a live view may carry, engine stamps included.
(live-view-lines view decl?)The sorted view fault lines of live wire view view, which refuse the whole view:
not a map, a view key that the schema refuses, a top node that is no map or has no
id, a shortcut rule, two nodes with one id, too many nodes or too many picture
bytes. A host checks a patched view with it, after each op had its node check.
The sorted view fault lines of live wire view `view`, which refuse the whole view: not a map, a view key that the schema refuses, a top node that is no map or has no id, a shortcut rule, two nodes with one id, too many nodes or too many picture bytes. A host checks a patched view with it, after each op had its node check.
Keys the ENGINE stamps on a live view, never written in a spec: its own identity, owning Activity invocation, arrival time, and patch counter.
Keys the ENGINE stamps on a live view, never written in a spec: its own identity, owning Activity invocation, arrival time, and patch counter.
Live log paint-window and patch bounds.
Live log paint-window and patch bounds.
(node-fault-text id lines)node <id> <lines> of node id, at most five lines.
`node <id> <lines>` of node `id`, at most five lines.
The most characters a human's stop note carries. Stopping a view is ALWAYS allowed, so a longer comment is cut to this rather than turned away: a refusal would leave the human watching work they already told to stop.
The most characters a human's stop note carries. Stopping a view is ALWAYS allowed, so a longer comment is cut to this rather than turned away: a refusal would leave the human watching work they already told to stop.
Every key one :options entry may carry.
Every key one `:options` entry may carry.
Default and maximum one-time-code lengths.
Default and maximum one-time-code lengths.
The head of the refusal of a live-view patch in every host.
The head of the refusal of a live-view patch in every host.
The most pixels in one picture, the most base64 characters of its data, and the most picture bytes in one live view.
The most pixels in one picture, the most base64 characters of its data, and the most picture bytes in one live view.
(picture-budget-error view)nil when the pictures of live view fit its byte bound, otherwise the reason.
nil when the pictures of live `view` fit its byte bound, otherwise the reason.
(picture-byte-count data)How many bytes the base64 data of a picture holds.
How many bytes the base64 `data` of a picture holds.
The media types that an image node shows.
The media types that an image node shows.
(picture-size data media-type)[width height] from the header of picture bytes data of media-type, or nil
when the header does not say.
`[width height]` from the header of picture bytes `data` of `media-type`, or nil when the header does not say.
Wire live-view placement to internal placement.
Wire live-view placement to internal placement.
Every key a field answered on a track may carry.
Every key a field answered on a track may carry.
(read-picture {:keys [media-type data width height]}){:width :height} of picture raw (:media-type, base64 :data, optional
:width and :height), or {:error reason}. The bytes must start like the
media type, the header must give a size within the pixel bound, and a declared
size must match the header. Data over the length bound is refused before it is
decoded.
`{:width :height}` of picture `raw` (`:media-type`, base64 `:data`, optional
`:width` and `:height`), or `{:error reason}`. The bytes must start like the
media type, the header must give a size within the pixel bound, and a declared
size must match the header. Data over the length bound is refused before it is
decoded.(request-error request)nil when request is a valid normalized request, otherwise a reason.
nil when `request` is a valid normalized request, otherwise a reason.
Keys the ENGINE stamps on a pending REQUEST, so every channel sees them on the
projected view although no spec may write one: the registry's arrival time.
Same category as derived-keys one level up — request-keys deliberately
refuses them on the way in, so a reader rebuilding a view that crossed a
process boundary lifts them across instead of re-parsing them.
Keys the ENGINE stamps on a pending REQUEST, so every channel sees them on the projected view although no spec may write one: the registry's arrival time. Same category as [[derived-keys]] one level up — `request-keys` deliberately refuses them on the way in, so a reader rebuilding a view that crossed a process boundary lifts them across instead of re-parsing them.
Defaults and bounds of a scene node and of one scene object.
Defaults and bounds of a scene node and of one scene object.
The fixed light of every scene, in camera space: :ambient, :diffuse and the unit :direction.
The fixed light of every scene, in camera space: `:ambient`, `:diffuse` and the unit `:direction`.
(scene-merge objects changes)Scene objects with changes merged in by id. A change keeps every key it
leaves out, so a moved object sends only its new place. A new id starts from
the defaults and keeps its slot after the objects before it.
Scene `objects` with `changes` merged in by id. A change keeps every key it leaves out, so a moved object sends only its new place. A new id starts from the defaults and keeps its slot after the objects before it.
Built-in mesh name to {:vertices :faces}. Every surface draws these arrays, so
one shape looks the same on each screen.
Built-in mesh name to `{:vertices :faces}`. Every surface draws these arrays, so
one shape looks the same on each screen.Prefix of an opaque secret answer handle.
Prefix of an opaque secret answer handle.
(secret-handle? value)True when value is an opaque handle minted for a secret-types field.
True when `value` is an opaque handle minted for a `secret-types` field.
Answer field types replaced by vault handles.
Answer field types replaced by vault handles.
Ten 100ms text frames per spinner variant, shared with Companion.
Ten 100ms text frames per spinner variant, shared with Companion.
Wire spinner variant to internal keyword.
Wire spinner variant to internal keyword.
Live table collection and patch bounds.
Live table collection and patch bounds.
Every key a typed field may carry.
Every key a typed field may carry.
Answer field types carrying text, excluding fixed-length one-time codes.
Answer field types carrying text, excluding fixed-length one-time codes.
(value-in-domain? field value)True when value fits the domain of the input component field. A blank
value always fits: a change is a draft, and only a submit checks requiredness.
True when `value` fits the domain of the input component `field`. A blank value always fits: a change is a draft, and only a submit checks requiredness.
Every key an answerable field may carry, whatever its type.
Every key an answerable field may carry, whatever its type.
Every key one operator action may carry, selected by :action. Keeping these
maps closed prevents a misspelled value or selection address from disappearing.
Every key one operator action may carry, selected by `:action`. Keeping these maps closed prevents a misspelled value or selection address from disappearing.
Wire operator action to internal action.
Wire operator action to internal action.
(view-fault-text lines)view <lines> of the view faults lines.
`view <lines>` of the view faults `lines`.
Wire View name to lifecycle kind.
Wire View name to lifecycle kind.
The head of the refusal of a live view in every host.
The head of the refusal of a live view in every host.
(wire-data value)value as JSON-shaped wire data: snake_case string keys and string enum values.
Unlike wire/->wire it keeps a non-finite number, so the check can refuse it.
`value` as JSON-shaped wire data: snake_case string keys and string enum values. Unlike [[wire/->wire]] it keeps a non-finite number, so the check can refuse it.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |