Liking cljdoc? Tell your friends :D

specomatic.core

Functions working with the specomatic schema.

Functions working with the specomatic schema.
raw docstring

all-field-defs-including-etypeclj/s

Returns a map of fields to field definitions, with the entity type assoc'd to the :etype key, in schema (memoized).

Returns a map of fields to field definitions, with the entity type assoc'd to the :etype key, in `schema` (memoized).
sourceraw docstring

all-field-defs-including-etype*clj/s

(all-field-defs-including-etype* schema)

Returns a map of fields to field definitions, with the entity type assoc'd to the :etype key, in schema.

Returns a map of fields to field definitions, with the entity type assoc'd to the :etype key, in `schema`.
sourceraw docstring

all-fieldsclj/s

Returns all fields defined in schema (memoized).

Returns all fields defined in `schema` (memoized).
sourceraw docstring

all-fields*clj/s

(all-fields* schema)

Returns all fields defined in schema.

Returns all fields defined in `schema`.
sourceraw docstring

defaults-schemaclj/s

(defaults-schema schema)

Given a schema, returns a (partial) schema containing defaults.

Given a `schema`, returns a (partial) schema containing defaults.
sourceraw docstring

dispatchclj/s

(dispatch schema etype field)

Given schema, entity type etype and field, returns the spec for the field if it is a keyword, or a description thereof if it is not.

Given `schema`, entity type `etype` and `field`, returns the spec for the field if it is a keyword, or a description thereof if it is not.
sourceraw docstring

display-name-fieldsclj/s

(display-name-fields schema etype)

Given the entity type etype, returns a set of fields (keywords) that are part of the display name of the entity type.

Given the entity type `etype`, returns a set of fields (keywords) that are part of the display name of the entity type.
sourceraw docstring

etype-defclj/s

(etype-def schema etype)

Given schema and entity type etype, returns a definition of the entity type.

Given `schema` and entity type `etype`, returns a definition of the entity type.
sourceraw docstring

etype-from-fieldclj/s

(etype-from-field schema field)

Given schema and field, returns the entity type of the field

Given `schema` and `field`, returns the entity type of the field
sourceraw docstring

etypesclj/s

(etypes schema)

Given schema, returns a sequence of all entity types defined in it.

Given `schema`, returns a sequence of all entity types defined in it.
sourceraw docstring

field-defclj/s

(field-def schema field)

Given schema and field, returns the definition of the field.

Given `schema` and `field`, returns the definition of the field.
sourceraw docstring

field-defined?clj/s

(field-defined? schema field)

Checks if field is defined in schema.

Checks if `field` is defined in `schema`.
sourceraw docstring

field-defsclj/s

(field-defs schema etype)

Given schema and entity type etype, returns a map of fields (keywords) to their definitions.

Given `schema` and entity type `etype`, returns a map of fields (keywords) to their definitions.
sourceraw docstring

field-defs-including-etypeclj/s

(field-defs-including-etype schema etype)

Given schema and entity type etype, returns a map of fields (keywords) to their definitions, with the entity type assoc'd to the :etype key.

Given `schema` and entity type `etype`, returns a map of fields (keywords) to their definitions, with the entity type assoc'd to the :etype key.
sourceraw docstring

full-schemaclj/s

(full-schema schema overrides)

Given a schema returned from specomatic.registry/schema spec and optionally overrides to override defaults, returns an schema enriched with defaults and inverse fields.

Given a `schema` returned from `specomatic.registry/schema` spec and optionally `overrides` to override defaults,
returns an schema enriched with defaults and inverse fields.
sourceraw docstring

id-fieldclj/s

(id-field schema etype)

Returns the id keyword for the entity type etype using the schema.

Returns the id keyword for the entity type `etype` using the `schema`.
sourceraw docstring

inverse-schemaclj/s

(inverse-schema schema overrides)

Given a schema and overrides to override inverse field keywords, returns a (partial) schema containing inverse field definitions.

Given a `schema` and `overrides` to override inverse field keywords, returns a (partial) schema containing inverse field definitions.
sourceraw docstring

reference-colls-by-owning-etypeclj/s

(reference-colls-by-owning-etype schema)

Returns a map of entity types to a map of reference collections owmed by them to their field definitions.

Returns a map of entity types to a map of reference collections owmed by them to their field definitions.
sourceraw docstring

required-fieldsclj/s

(required-fields schema etype)

Given schema and the entity type etype, returns the set of required fields.

Given `schema` and the entity type `etype`, returns the set of required fields.
sourceraw docstring

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

× close