spec-tools.data-spec — metosin/spec-tools 0.10.5

Data Specs

maybe clj/s

(maybe v)

Makes a value nillable:

{:name string?
 :age (ds/maybe int?)}

Maybe clj/s

maybe? clj/s

(maybe? x)

Test if the value is wrapped with maybe

opt clj/s

(opt k)

Makes a key optional:

{:name string?
 (ds/opt :age) int?}

opt? clj/s

(opt? x)

Test if the key is wrapped with opt

OptionalKey clj/s

or clj/s

(or v)

Or clj/s

or? clj/s

(or? x)

req clj/s

(req k)

Makes a key required:

{:name string?
 (ds/req :age) int?}

req? clj/s

(req? x)

Test if the key is wrapped with req

RequiredKey clj/s

spec clj/s

(spec {data :spec name :name nested? :spec-tools.data-spec/nested? :as opts})

(spec name data)

Creates a clojure.spec.alpha/Spec out of a data-spec. Supports 2 arities:

;; arity1
(ds/spec
  {:spec {:i int?}
   :name ::map})

;; arity2 (legacy)
(ds/spec ::map {:i int?})

The following options are valid for the 1 arity case:

Key	Description
:spec	The wrapped data-spec.
:name	Qualified root spec name - used to generate unique names for sub-specs.
:keys-spec	Function to wrap not-wrapped keys, e.g. opt to make keys optional by default.
:keys-default	Function to generate the keys-specs, default [[keys-specs]].

unwrap-key clj/s

(unwrap-key x)

Unwrap the opt or req key.

wrapped-key? clj/s

(wrapped-key? x)

Test if the key is wrapped with opt or req