schema.spec.collection — prismatic/schema 1.3.0

A collection spec represents a collection of elements, each of which is itself schematized.

all-elements clj/s

(all-elements schema)

collection-spec clj/s

(collection-spec pre konstructor elements on-error)

A collection represents a collection of elements, each of which is itself schematized. At the top level, the collection has a precondition (presumably on the overall type), a constructor for the collection from a sequence of items, an element spec, and a function that constructs a descriptive error on failure.

The element spec is a nested list structure, in which the leaf elements each provide an element schema, parser (allowing for efficient processing of structured collections), and optional error wrapper. Each item in the list can be a leaf element or an optional nested element spec (see below). In addition, the final element can be a remaining schema (see below).

Note that the optional carries no semantics with respect to validation; the user must ensure that the parser enforces the desired semantics, which should match the structure of the spec for proper generation.

CollectionSpec clj/s

one-element clj/s

(one-element required? schema parser)

optional clj/s

(optional & ss)

If any more elements are present, they must match the elements in 'ss'

optional-tail clj/s

(optional-tail schema parser more)

remaining clj/s

(remaining s)

All remaining elements must match schema s

subschemas clj/s

(subschemas elt)