Liking cljdoc? Tell your friends :D
bling.explain
explain-malliclj/s
(explain-malli schema v)(explain-malli schema
v
{:keys [:file :line :column :function-name :spacing
:display-schema? :display-explain-data? :callout-opts]})Prints a malli validation error callout block via bling.core/callout.
Within the block, the value is pretty-printed, potentially with syntax
coloring. The problem value is highlighted with the :highlight-error
class of the active fireworks theme, or the :highlight-error-underlined
class, if the value is not a collection.
If two arguments are provided, the second should be a map with the following optional keys:
| Key | Pred | Description |
|---|---|---|
:function-name | string? | The name of the function that can be used to construct the source location. Optional. |
:file | pos-int? or string? | The file name that can be used to construct the source location. Optional. |
:line | pos-int? or string? | The line number that can be used to construct the source location. Optional. |
:column | pos-int? or string? | The column number that can be used to construct the source location. Optional. |
:spacing | #{:compact} | If the value of :spacing is set to :compact, the callout is compacted vertically. |
:display-schema? | boolean? | Displays the schema passed to the underlying call to malli.core/explain. |
:display-explain-data? | boolean? | Displays the output of malli.core/explain within the callout block. |
:callout-opts | map? | A map of options for the underlying call to bling.core/callout. |
Prints a malli validation error callout block via bling.core/callout.
Within the block, the value is pretty-printed, potentially with syntax
coloring. The problem value is highlighted with the `:highlight-error`
class of the active fireworks theme, or the `:highlight-error-underlined`
class, if the value is not a collection.
If two arguments are provided, the second should be a map with the following
optional keys:
| Key | Pred | Description |
| :--------------- | ----------------------- | ------------------------------------------------------------ |
| `:function-name` | `string?` | The name of the function that can be used to construct the source location. Optional.
| `:file` | `pos-int?` or `string?` | The file name that can be used to construct the source location. Optional.
| `:line` | `pos-int?` or `string?` | The line number that can be used to construct the source location. Optional.
| `:column` | `pos-int?` or `string?` | The column number that can be used to construct the source location. Optional.
| `:spacing` | `#{:compact}` | If the value of `:spacing` is set to `:compact`, the callout is compacted vertically.
| `:display-schema?` | `boolean?` | Displays the schema passed to the underlying call to `malli.core/explain`.
| `:display-explain-data?` | `boolean?` | Displays the output of `malli.core/explain` within the callout block.
| `:callout-opts` | `map?` | A map of options for the underlying call to bling.core/callout. |cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close