c3kit.apron.schema — com.cleancoders.c3kit/apron 2.1.3

Defines data structure, coerces, validates.

->bigdec clj/s

(->bigdec v)

->boolean clj/s

(->boolean value)

->date clj/s

(->date v)

->float clj/s

(->float v)

->int clj/s

(->int v)

->keyword clj/s

(->keyword value)

->seq clj/s

(->seq v)

->sql-date clj/s

(->sql-date v)

->string clj/s

(->string value)

->timestamp clj/s

(->timestamp v)

->uri clj/s

(->uri v)

->uuid clj/s

(->uuid v)

-process-entity-level-spec clj/s multimethod

-process-error clj/s multimethod

-process-field-spec clj/s multimethod

-process-spec-on-value clj/s

(-process-spec-on-value process spec value)

bigdec? clj/s

(bigdec? v)

coerce clj/s

(coerce schema entity)

Returns coerced entity or SchemaError if any coercion failed. Use error? to check result. Use Case: 'I want to change my data into the types specified by the schema.'

coerce! clj/s

(coerce! schema entity)

Returns a coerced entity or throws an exception if there are errors.

coerce-errors clj/s

(coerce-errors schema entity)

DEPRECATED

coerce-message-map clj/s

(coerce-message-map schema entity)

Runs coerce on the entity and returns a map of error message, or nil if none.

coerce-value clj/s

(coerce-value spec value)

(coerce-value schema key value)

DEPRECATED

coerce-value! clj/s

(coerce-value! spec value)

(coerce-value! schema key value)

returns coerced value or throws an exception

conform clj/s

(conform schema entity)

Returns coerced entity or SchemaError upon any coercion or validation failure. Use error? to check result. Use Case: 'I want to coerce my data then validate the coerced data, all according to the schema.' Use Case: Data comes in from a web-form so strings have to be coerced into numbers, etc., then we need to validate that the data is good.

conform! clj/s

(conform! schema entity)

Returns a conformed entity or throws an exception if there are errors.

conform-errors clj/s

(conform-errors schema entity)

DEPRECATED

conform-message-map clj/s

(conform-message-map schema entity)

Runs conform on the entity and returns a map of error message, or nil if none.

conform-schema! clj/s

(conform-schema! schema)

Normalizes, coerces, and validates all the specs in the schema. Any problems in the schema will throw an exception. Any extra fields in the spec (:value, :db, ...) will be preserved.

conform-value clj/s

(conform-value spec value)

(conform-value schema key value)

DEPRECATED

conform-value! clj/s

(conform-value! spec value)

(conform-value! schema key value)

coerce and validate, returns coerced value or throws

date clj/s

email-pattern clj/s

email? clj/s

(email? value)

entity-spec-schema clj/s

error-data clj/s

(error-data field-error)

Return the data map associated with the FieldError.

error-exception clj/s

(error-exception field-error)

Return the exception attached to a FieldError if any, otherwise nil.

error-map clj/s

(error-map result)

error-message clj/s

(error-message error)

Return the message of an error.

error-message-map clj/s

(error-message-map result)

DEPRECATED

error-seq clj/s

(error-seq entity)

Returns a sequence of all the FieldErrors in a processed entity.

error-type clj/s

(error-type field-error)

Return the target type of a CoerceError, if any, otherwise nil.

error-value clj/s

(error-value field-error)

Return the value that caused the FieldError, if any, otherwise nil.

error? clj/s

(error? entity)

Return true if the processed entity has errors, false otherwise.

field-error? clj/s

(field-error? value)

Returns true if the value is a FieldError, false otherwise.

FieldError clj/s protocol

id clj/s

is-enum? clj/s

(is-enum? enum)

kind clj/s

(kind key)

merge-schemas clj/s

(merge-schemas & schemas)

merge-specs clj/s

(merge-specs a b)

message-map clj/s

(message-map result)

nil when there are no errors, otherwise a map {<field> <error message>}.

message-seq clj/s

(message-seq result)

seq of 'friendly' error messages; nil if none.

messages clj/s

(messages result)

DEPRECATED

nil-or clj/s

(nil-or f)

nil?-or clj/s

(nil?-or f)

normalize-schema clj/s

(normalize-schema schema)

Returns the schema with all shorthand specs expanded.

normalize-spec clj/s

(normalize-spec spec)

If the spec is using a shorthand, it will be expanded.

normalized? clj/s

(normalized? schema-or-spec)

Returns true if the schema-or-spec has been normalized, false otherwise.

omit clj/s

Used as a :present value to remove the entry from presentation

parse! cljs

(parse! f v)

present clj/s

(present schema entity)

Returns presented entity with FieldErrors where the process failed. Use error? to check result.

present! clj/s

(present! schema entity)

Returns a presented entity or throws an exception if there are errors.

present-value clj/s

(present-value spec value)

(present-value schema key value)

DEPRECATED

present-value! clj/s

(present-value! spec value)

(present-value! schema key value)

returns a presentable representation of the value, or throws

present? clj/s

(present? v)

process-map-spec-on-value clj/s

(process-map-spec-on-value process spec value)

process-one-of-on-value clj/s

(process-one-of-on-value process spec value)

process-spec-schema clj/s

required clj/s

spec-schema clj/s

str-or-nil clj/s

(str-or-nil v)

type-coercer! clj/s

(type-coercer! type)

type-coercers clj/s

type-validator! clj/s

(type-validator! type)

type-validators clj/s

uri? clj/s

(uri? value)

valid-types clj/s

valid-value? clj/s

(valid-value? spec value)

(valid-value? schema key value)

return true or false

validate clj/s

(validate schema entity)

Returns entity with all values true, or SchemaError when one or more invalid fields. Use error? to check result. Use Case: 'I want to make sure all the data is valid according to the schema.'

validate! clj/s

(validate! schema entity)

Returns a validated entity or throws an exception if there are errors.

validate-errors clj/s

(validate-errors schema entity)

DEPRECATED

validate-message-map clj/s

(validate-message-map schema entity)

Runs validate on the entity and returns a map of error message, or nil if none.

validate-value! clj/s

(validate-value! spec value)

(validate-value! schema key value)

throws an exception when validation fails, value otherwise

validation-errors clj/s

(validation-errors schema entity)

DEPRECATED

validation-schema clj/s