Schema-tools Api Documentation

Assoc[iate]s key & vals into Schema.

Associates a value in a nested associative Schema, where ks is a sequence of keys and v is the new value and returns a new nested Schema. If any levels do not exist, hash-maps will be created.

Dissoc[iate]s keys from Schema.

Dissociates an entry from a nested associative Schema returning a new nested structure. keys is a sequence of keys. Any empty maps that result will not be present in the new Schema.

Returns the value in a nested associative Schema, where ks is a sequence of keys. Returns nil if the key is not present, or the not-found value if supplied.

Returns a Schema that consists of the rest of the Schemas conj-ed onto the first. If a schema key occurs in more than one map, the mapping from the latter (left-to-right) will be the mapping in the result. Works only with Map schemas.

Makes given map keys optional. Defaults to all keys.

Makes given map keys required. Defaults to all keys.

Returns the schema var if the schema contains the :name and :ns definitions (set by schema.core/defschema).

Returns the schema description, in this lookup order: a) schema meta :description b) schema var meta :doc if not "" c) nil

Returns the description of a schema attached via schema-with-description.

Returns the sub-schema or sub-schemas of given schema.

Records description in schema’s metadata.

Like clojure.core/select-keys but handles boths optional-keys and required-keys.

Strips all disallowed keys from nested Map schemas via coercion. Takes an optional coercion matcher for extra coercing the selected value(s) on a single sweep. If a value can’t be coerced to match the schema ExceptionInfo is thrown (like schema.core/validate).

Updates a value in a map with a function.

‘Updates’ a value in a nested associative Schema, where ks is a sequence of keys and f is a function that will take the old value and any supplied args and return the new value, and returns a new nested Schema. If any levels do not exist, hash-maps will be created.