Liking cljdoc? Tell your friends :D

minimallist.helper


*clj/s

(* model)

Sequence model of a model being either absent or repeated an arbitrary number of times.

Sequence model of a model being either absent or repeated an
arbitrary number of times.
sourceraw docstring

+clj/s

(+ model)

Sequence model of a model being repeated an arbitrary number of times.

Sequence model of a model being repeated an
arbitrary number of times.
sourceraw docstring

?clj/s

(? model)

Sequence model of a model being either absent or present.

Sequence model of a model being either absent or present.
sourceraw docstring

altclj/s

(alt & entries)

Model of a choice (alternative) between different possible entries.

Model of a choice (alternative) between different possible entries.
sourceraw docstring

andclj/s

(and & conditions)

Model for validating a value against a conjunction of models.

Model for validating a value against a conjunction of models.
sourceraw docstring

catclj/s

(cat & entries)

Sequence model of a concatenation of models. The sequence models in the entries are inlined by default.

Sequence model of a concatenation of models.
The sequence models in the entries are inlined by default.
sourceraw docstring

char-catclj/s

(char-cat s)

A cat sequence of chars, built from a string which contains them.

A cat sequence of chars, built from a string which contains them.
sourceraw docstring

char-setclj/s

(char-set s)

A set of chars, built from a string which contains them.

A set of chars, built from a string which contains them.
sourceraw docstring

enumclj/s

(enum values-set)

Model of one value from a set.

Model of one value from a set.
sourceraw docstring

fnclj/s

(fn predicate)

Model for values verifying custom predicates.

Model for values verifying custom predicates.
sourceraw docstring

in-listclj/s

(in-list sequence-model)

Specifies the :coll-type to be a list. To be used on sequence model nodes, namely :sequence-of, :sequence, :cat and :repeat.

Specifies the :coll-type to be a list.
To be used on sequence model nodes, namely :sequence-of, :sequence, :cat and :repeat.
sourceraw docstring

in-stringclj/s

(in-string sequence-model)

Specifies the :coll-type to be a string. To be used on sequence model nodes, namely :sequence-of, :sequence, :cat and :repeat.

Specifies the :coll-type to be a string.
To be used on sequence model nodes, namely :sequence-of, :sequence, :cat and :repeat.
sourceraw docstring

in-vectorclj/s

(in-vector sequence-model)

Specifies the :coll-type to be a vector. To be used on sequence model nodes, namely :sequence-of, :sequence, :cat and :repeat.

Specifies the :coll-type to be a vector.
To be used on sequence model nodes, namely :sequence-of, :sequence, :cat and :repeat.
sourceraw docstring

letclj/s

(let bindings body)

Model with local model definitions.

Model with local model definitions.
sourceraw docstring

listclj/s

(list & entries)

Same as tuple, but inside a list.

Same as tuple, but inside a list.
sourceraw docstring

list-ofclj/s

(list-of elements-model)

Same as sequence-of, but inside a list.

Same as sequence-of, but inside a list.
sourceraw docstring

mapclj/s

(map)
(map & entries)

Model of a hashmap with specified models for each of its entries.

Model of a hashmap with specified models for each of its entries.
sourceraw docstring

map-ofclj/s

(map-of entry-model)

Model of a hashmap made of entries (2-vector) of a specific model.

Model of a hashmap made of entries (2-vector) of a specific model.
sourceraw docstring

not-inlinedclj/s

(not-inlined sequence-model)

Specify that this sequence model should not be inlined within its parent model. Useful on nodes :alt, :cat and :repeat.

Specify that this sequence model should not be inlined within its parent model.
Useful on nodes :alt, :cat and :repeat.
sourceraw docstring

orclj/s

(or & conditions)

Model for validating a value against a disjunction of models.

Model for validating a value against a disjunction of models.
sourceraw docstring

refclj/s

(ref key)

A reference to a model locally defined.

A reference to a model locally defined.
sourceraw docstring

repeatclj/s

(repeat min max elements-model)

Sequence model of a repetition of a model. If elements-model is a sequence model, it is inlined by default.

Sequence model of a repetition of a model.
If elements-model is a sequence model, it is inlined by default.
sourceraw docstring

sequence-ofclj/s

(sequence-of elements-model)

Model of a sequence of values, all matching a specific model.

Model of a sequence of values, all matching a specific model.
sourceraw docstring

set-ofclj/s

(set-of elements-model)

Model of a set of values matching a specific model.

Model of a set of values matching a specific model.
sourceraw docstring

string-ofclj/s

(string-of elements-model)

Same as sequence-of, but inside a string.

Same as sequence-of, but inside a string.
sourceraw docstring

string-tupleclj/s

(string-tuple & entries)

Same as tuple, but inside a string.

Same as tuple, but inside a string.
sourceraw docstring

tupleclj/s

(tuple & entries)

A sequence of values, each matching their specific model.

A sequence of values, each matching their specific model.
sourceraw docstring

valclj/s

(val value)

Model for a fixed value.

Model for a fixed value.
sourceraw docstring

vectorclj/s

(vector & entries)

Same as tuple, but inside a vector.

Same as tuple, but inside a vector.
sourceraw docstring

vector-ofclj/s

(vector-of elements-model)

Same as sequence-of, but inside a vector.

Same as sequence-of, but inside a vector.
sourceraw docstring

with-conditionclj/s

(with-condition model condition-model)

Specifies a :condition-model to a model

Specifies a :condition-model to a model
sourceraw docstring

with-countclj/s

(with-count collection-model count-model)

Specifies a :count-model to a collection model with varying size, namely :set-of, :map-of and :sequence-of.

Specifies a :count-model to a collection model with varying size,
namely :set-of, :map-of and :sequence-of.
sourceraw docstring

with-entriesclj/s

(with-entries map-model & entries)

Adds entries to a :map model.

Adds entries to a :map model.
sourceraw docstring

with-optional-entriesclj/s

(with-optional-entries map-model & entries)

Adds optional entries to a :map model.

Adds optional entries to a :map model.
sourceraw docstring

with-test-check-genclj/s

(with-test-check-gen model generator)

Specifies a test-check generator to a model.

Specifies a test-check generator to a model.
sourceraw docstring

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

× close