spec-tools.core — metosin/spec-tools 0.8.3-SNAPSHOT

+problems+ clj/s

coerce clj/s

(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.

Coercion clj/s≠ protocol

-coerce clj/s

(-coerce this value transformer options)

conform clj/s

(conform spec value)

(conform spec value transformer)

Given a spec and a value, returns the possibly destructured value or ::s/invalid

conform! clj/s

(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.

create-spec clj/s

(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)

decode clj/s

(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.

encode clj/s

(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.

explain clj/s

(explain spec value)

(explain spec value transformer)

explain-data clj/s

(explain-data spec value)

(explain-data spec value transformer)

fail-on-extra-keys-transformer clj/s

into-spec clj/s

(into-spec x)

json-transformer clj/s

merge clj/s macro

(merge & forms)

merge-impl clj/s

(merge-impl forms spec-form merge-spec)

select-spec clj/s

(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.

spec clj/s macro

(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.

Spec cljs

spec-description clj/s

(spec-description spec)

Returns a spec description.

spec-name clj/s

(spec-name spec)

Returns a spec name. Like the private clojure.spec.alpha/spec-name

spec? clj/s

(spec? x)

string-transformer clj/s

strip-extra-keys-transformer clj/s

Transformer clj/s≠ protocol

-decoder clj/s

(-decoder this spec value)

-encoder clj/s

(-encoder this spec value)

-name clj/s

(-name this)

type-transformer clj/s

(type-transformer {transformer-name :name
                   :keys [encoders decoders default-encoder default-decoder]})

walk clj/s multimethod