(coerce spec value transformer)(coerce spec value transformer options)Coerces the value using a Transformer. Returns original value for
those parts of the value that can't be trasformed.
Coerces the value using a [[Transformer]]. Returns original value for those parts of the value that can't be trasformed.
(conform spec value)(conform spec value transformer)Given a spec and a value, returns the possibly destructured value or ::s/invalid
Given a spec and a value, returns the possibly destructured value or ::s/invalid
(conform! spec value)(conform! spec value transformer)Given a spec and a value, returns the possibly destructured value or fails with ex-info with :type of ::conform. ex-data also contains :problems, :spec and :value. call s/unform on the result to get the actual conformed value.
Given a spec and a value, returns the possibly destructured value or fails with ex-info with :type of ::conform. ex-data also contains :problems, :spec and :value. call s/unform on the result to get the actual conformed value.
(create-spec {:keys [spec type form] :as m})Creates a Spec intance from a map containing the following keys:
:spec the wrapped spec predicate (mandatory)
:form source code of the spec predicate, if :spec is a spec,
:form is read with `s/form` out of it. For non-spec
preds, spec-tools.form/resolve-form is called, if still
not available, spec-creation will fail.
:type optional type for the spec. if not set, will be auto-
resolved via spec-tools.parse/parse-spec (optional)
:reason reason to be added to problems with s/explain (optional)
:gen generator function for the spec (optional)
:name name of the spec (optional)
:description description of the spec (optional) :xx/yy any qualified keys can be added (optional)
Creates a Spec intance from a map containing the following keys:
:spec the wrapped spec predicate (mandatory)
:form source code of the spec predicate, if :spec is a spec,
:form is read with `s/form` out of it. For non-spec
preds, spec-tools.form/resolve-form is called, if still
not available, spec-creation will fail.
:type optional type for the spec. if not set, will be auto-
resolved via spec-tools.parse/parse-spec (optional)
:reason reason to be added to problems with s/explain (optional)
:gen generator function for the spec (optional)
:name name of the spec (optional)
:description description of the spec (optional)
:xx/yy any qualified keys can be added (optional)(decode spec value)(decode spec value transformer)Decodes a value using a Transformer from external format to a value
defined by the spec. First, calls coerce and returns the value if it's
valid - otherwise, calls conform & [[unform]]. Returns ::s/invalid
if the value can't be decoded to conform the spec.
Decodes a value using a [[Transformer]] from external format to a value defined by the spec. First, calls [[coerce]] and returns the value if it's valid - otherwise, calls [[conform]] & [[unform]]. Returns `::s/invalid` if the value can't be decoded to conform the spec.
(encode spec value transformer)Transforms a value (using a Transformer) from external
format into a value defined by the spec. On error, returns ::s/invalid.
Transforms a value (using a [[Transformer]]) from external format into a value defined by the spec. On error, returns `::s/invalid`.
(select-spec spec value)Drops all extra keys out of a Keys spec value. To use this recursively, wrap all child Keys Specs into Spec Records. See CLJ-2116 for details.
Drops all extra keys out of a Keys spec value. To use this recursively, wrap all child Keys Specs into Spec Records. See CLJ-2116 for details.
(spec pred-or-info)(spec pred info)Creates a Spec instance with one or two arguments:
;; using type inference (spec integer?)
;; with explicit type (spec integer? {:type :long})
;; map form (spec {:spec integer?, :type :long})
calls create-spec, see it for details.
Creates a Spec instance with one or two arguments:
;; using type inference
(spec integer?)
;; with explicit type
(spec integer? {:type :long})
;; map form
(spec {:spec integer?, :type :long})
calls `create-spec`, see it for details.(spec-description spec)Returns a spec description.
Returns a spec description.
(spec-name spec)Returns a spec name. Like the private clojure.spec.alpha/spec-name
Returns a spec name. Like the private clojure.spec.alpha/spec-name
(-decoder this spec value)(-encoder this spec value)(-name this)(type-transformer {transformer-name :name
:keys [encoders decoders default-encoder default-decoder]})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 |