metosin/spec-tools spec-tools.core 0.7.0 docs

Positional factory function for class spec_tools.core.Spec.

Returns a spec from a spec name or spec. Throwns exception
if no spec was found.

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

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.forms/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.forms/resolve-type (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)

Transforms and validates a value (using a [[Transformer]]) from external
format into a value defined by the spec. On error, returns ::s/invalid.

Reads specs from a string.
TODO: Should optionally read the realated Registry entries.

Transforms a valid value (using a [[Transformer]]) from external
format into a value defined by the spec. Allows values to be
transformed into illegal ones.

Finds recursively a spec implementation from the registry

Factory function for class spec_tools.core.Spec, taking a map of keywords to field values.

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.

Writes specs into a string that can be read by the reader.
TODO: Should optionally write the realated Registry entries.

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.

Returns a spec description.

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