Liking cljdoc? Tell your friends :D

flanders.core


anyclj/s

source

any-boolclj/s

source

any-instclj/s

source

any-intclj/s

source

any-keywordclj/s

source

any-numclj/s

source

any-strclj/s

source

any-str-seqclj/s

source

any-string-seqclj/s

source

anythingclj/s

(anything & {:as opts})
source

boolclj/s

(bool & {:keys [equals default] :as opts})
source

conditionalclj/s

(conditional & pred+types)
source

def-entity-typeclj/smacro

(def-entity-type name description & map-entries)
source

def-enum-typeclj/smacro

(def-enum-type name values & opts)
source

def-eqclj/smacro

(def-eq name value & opts)
source

def-map-typeclj/smacro

(def-map-type name map-entries & {:as opts})
source

eitherclj/s

(either & {:keys [choices] :as opts})

Build an EitherType with the keyword arguments opts.

(either :choices [(int) (str)]) ;; => #flanders.types.EitherType{:choices [,,,]}

This function requires the value of the :choices key be a sequence of at least length 1.

(either :choices [(int) (str)]) ;; => AssertionError Assert failed: either expects at least one choice

Build an EitherType with the keyword arguments `opts`.

  (either :choices [(int) (str)])
  ;; =>
  #flanders.types.EitherType{:choices [,,,]}

This function requires the value of the `:choices` key be a sequence
of at least length 1.

  (either :choices [(int) (str)])
  ;; =>
  AssertionError Assert failed: either expects at least one choice
sourceraw docstring

entryclj/s

(entry k t & {:keys [required?] :or {required? true} :as opts})
source

enumclj/s

(enum values & {:keys [open?] :or {open? false} :as opts})
source

eqclj/s

(eq value & {:keys [description reference comment usage name]})
source

instclj/s

(inst & {:as opts})
source

intclj/s

(int & {:keys [equals default] :as opts})
source

keyclj/s

(key equals & {:as opts})
source

keywordclj/s

(keyword & {:keys [equals default] :as opts})
source

mapclj/s

(map entries & {:as opts})

Make a MapType containing the given entries. Note that nothing is done to enforce uniqueness of the entries keys. Duplicate keys are handled at the discretion of the fn that is walking the DDL tree, though it should be assumed that later duplicates replace earlier ones (as when merging maps).

Make a MapType containing the given entries.
Note that nothing is done to enforce uniqueness of the entries keys.
Duplicate keys are handled at the discretion of the fn that is
walking the DDL tree, though it should be assumed that later
duplicates replace earlier ones (as when merging maps).
sourceraw docstring

map-ofclj/s

(map-of {:as opts} & entry-lists)

Build a MapType with a map of options followed by lists of entries. Useful when composing lists of required-entries, optional-entries, and predefined entries.

Build a MapType with a map of options followed by lists of entries.
Useful when composing lists of required-entries, optional-entries,
and predefined entries.
sourceraw docstring

numclj/s

(num & {:keys [equals default] :as opts})
source

optional-entriesclj/s

(optional-entries & entries)
source

required-entriesclj/s

(required-entries & entries)
source

seq-ofclj/s

(seq-of t & {:as opts})
source

set-ofclj/s

(set-of t & {:as opts})
source

sigclj/s

(sig & {:keys [parameters rest-parameter return] :as opts})

Build a SignatureType with the keyword arguments opts.

(sig :parameters [(int) (str)] :return (str)) ;; => #flanders.types.SignatureType{:parameters [,,,] :return #flanders.types.StringType{,,,}}

If the :return option is not specified the return type of the signature is will be specified as flanders.types.AnythingType.

A signature can be variadic by specifying the :rest-parameter argument.

Build a SignatureType with the keyword arguments `opts`.

  (sig :parameters [(int) (str)]
       :return (str))
  ;; =>
  #flanders.types.SignatureType{:parameters [,,,]
                                :return #flanders.types.StringType{,,,}}

If the `:return` option is not specified the return type of the
signature is will be specified as `flanders.types.AnythingType`.

A signature can be variadic by specifying the `:rest-parameter`
argument.
sourceraw docstring

strclj/s

(str & {:keys [equals default] :as opts})
source

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

× close