Liking cljdoc? Tell your friends :D

com.blockether.vis.contract.document

Loads JSON contract documents and validates them with their same-named JSON Schemas. schema/common.json supplies shared definitions. Raw validators reject values outside the JSON data model; engine adapters may normalize keyword maps before validation.

Loads JSON contract documents and validates them with their same-named JSON Schemas.
`schema/common.json` supplies shared definitions. Raw validators reject values outside
the JSON data model; engine adapters may normalize keyword maps before validation.
raw docstring

explainclj

(explain document-name value)
(explain document-name definition value)

JSON Schema errors for value, or nil when it satisfies the document root or named definition. Clojure keyword maps are normalized to their JSON spelling before definition validation.

JSON Schema errors for `value`, or nil when it satisfies the document root or
named definition. Clojure keyword maps are normalized to their JSON spelling
before definition validation.
sourceraw docstring

explain-jsonclj

(explain-json document-name definition value)

JSON Schema errors without converting Clojure values into JSON spellings.

JSON Schema errors without converting Clojure values into JSON spellings.
sourceraw docstring

load!clj

(load! document-name)

The contract document named document-name, parsed and validated against its schema. Throws :vis/contract-missing when either file is off the classpath and :vis/contract-invalid, carrying the schema errors, when the document does not satisfy the schema.

The contract document named `document-name`, parsed and validated against its
schema. Throws `:vis/contract-missing` when either file is off the classpath
and `:vis/contract-invalid`, carrying the schema errors, when the document does
not satisfy the schema.
sourceraw docstring

schema-documentclj

(schema-document document-name)

The parsed JSON Schema document named document-name.

The parsed JSON Schema document named `document-name`.
sourceraw docstring

valid-json?clj

(valid-json? document-name definition value)

True when raw JSON-shaped data satisfies a named definition.

True when raw JSON-shaped data satisfies a named definition.
sourceraw docstring

valid?clj

(valid? document-name value)
(valid? document-name definition value)

True when value satisfies the document root or named JSON Schema definition.

True when `value` satisfies the document root or named JSON Schema definition.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close