Liking cljdoc? Tell your friends :D

spec-tools.core


+invalid+clj/s

source

+problems+clj/s

source

conformclj/s

(conform spec value)
(conform spec value conforming)

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
sourceraw docstring

conform!clj/s

(conform! spec value)
(conform! spec value conforming)

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

create-specclj/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.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)

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)
sourceraw docstring

docclj/smacro

(doc pred-or-info)
(doc spec info)

Creates a Spec instance with one or two arguments, setting the :type to nil (e.g. no dynamic conforming).

;; using type inference (doc integer?)

;; with explicit type (doc integer? {:name "it's a integer"})

;; map form (doc {:spec integer?, :name "it's a integer"}})

calls spec, see it for details.

Creates a Spec instance with one or two arguments,
setting the :type to nil (e.g. no dynamic conforming).

;; using type inference
(doc integer?)

;; with explicit type
(doc integer? {:name "it's a integer"})

;; map form
(doc {:spec integer?, :name "it's a integer"}})

calls `spec`, see it for details.
sourceraw docstring

explainclj/s

(explain spec value)
(explain spec value conforming)
source

explain-dataclj/s

(explain-data spec value)
(explain-data spec value conforming)
source

fail-on-extra-keys-conformingclj/s

source

json-conformingclj/s

source

mergeclj/s≠macro

clj
(merge & forms)
cljs
(merge &form &env & forms)
source (clj)source (cljs)

merge-implclj/s

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

select-specclj/s

(select-spec spec value)
source

specclj/smacro

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

Speccljs

source

spec-descriptionclj/s

(spec-description spec)

Returns a spec description.

Returns a spec description.
sourceraw docstring

spec-nameclj/s

(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
sourceraw docstring

spec?clj/s

(spec? x)
source

string-conformingclj/s

source

strip-extra-keys-conformingclj/s

source

type-conformingclj/s

(type-conforming opts)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close