(assert-compatible-lang book lang)asserts that the lang is compatible
asserts that the lang is compatible
(assert-entry book module-id section symbol-id)asserts that module exists
asserts that module exists
(assert-module book module-id)asserts that module exists
asserts that module exists
(book {:keys [lang meta grammar modules parent merged] :as m})creates a book
creates a book
(book-entry {:keys [lang id module section form form-input deps deps-native
namespace template standalone declared]
:as m})creates a book entry
creates a book entry
(book-entry? x)checks if object is a book entry
checks if object is a book entry
(book-from snapshot lang)returns the merged book given snapshot
returns the merged book given snapshot
(book-merge book parent)merges a book with it's parent
merges a book with it's parent
(book-meta {:keys [bootstrap module-import module-export module-link has-module
setup-module teardows-module has-ptr setup-ptr teardown-ptr]
:as m})creates a book meta
(book-meta {:module-export (fn [{:keys [as]} opts]
(h/$ (return ~as)))
:module-import (fn [name {:keys [as]} opts]
(h/$ (var ~as := (require ~(str name)))))
:has-ptr (fn [ptr]
(list 'not= (ut/sym-full ptr) nil))
:teardown-ptr (fn [ptr]
(list := (ut/sym-full ptr) nil))})
=> book-meta?
creates a book meta
(book-meta {:module-export (fn [{:keys [as]} opts]
(h/$ (return ~as)))
:module-import (fn [name {:keys [as]} opts]
(h/$ (var ~as := (require ~(str name)))))
:has-ptr (fn [ptr]
(list 'not= (ut/sym-full ptr) nil))
:teardown-ptr (fn [ptr]
(list := (ut/sym-full ptr) nil))})
=> book-meta?(book-meta? x)checks if object is a book meta
checks if object is a book meta
(book-module {:keys [lang id alias link internal native native-lu require-impl
fragment code static display]
:as m})creates a book module
creates a book module
(book-module? x)checks of object is a book module
checks of object is a book module
(book-string {:keys [lang meta grammar modules parent scope]})shows the book string
shows the book string
(check-compatible-lang book lang)checks if the lang is compatible with the book
checks if the lang is compatible with the book
(delete-entry book module-id section symbol-id)deletes an entry
deletes an entry
(delete-module book module-id)deletes a module given a book
deletes a module given a book
(delete-modules book module-ids)deletes all modules
deletes all modules
(get-base-entry {:keys [modules] :as book} module-id id section)gets an entry in the book
gets an entry in the book
(get-code-deps {:keys [modules grammar lang] :as book} id)gets :deps or if a :static/template calculate dependencies
gets `:deps` or if a `:static/template` calculate dependencies
(get-code-entry {:keys [modules] :as book} id)gets a code entry in the book
gets a code entry in the book
(get-deps {:keys [modules] :as book} id)get dependencies for a given id
get dependencies for a given id
(get-deps-native {:keys [modules] :as book} id)get dependencies for a given id
get dependencies for a given id
(get-entry {:keys [modules] :as book} id)gets either the module or code entry
gets either the module or code entry
(get-fragment-entry {:keys [modules] :as book} id)gets a code entry in the book
gets a code entry in the book
(get-module {:keys [modules] :as book} id)gets the module
gets the module
(has-entry? book module-id section symbol-id)checks that book has an entry
checks that book has an entry
(has-module? book module-id)checks that a books has a given module
checks that a books has a given module
(list-entries book)(list-entries {:keys [modules]} dep-types)lists entries for a given symbol
lists entries for a given symbol
(module-create {:keys [lang] :as book} module-id options)creates a module given book and options
creates a module given book and options
(module-create-check {:keys [modules] :as book} module-id link)checks that bundles are available
checks that bundles are available
(module-create-filename book module-id)creates a filename for module
creates a filename for module
(module-create-requires require)creates a map for the requires
creates a map for the requires
(put-entry book entry)updates entry value in the book
updates entry value in the book
(put-module book module)adds or updates a module
adds or updates a module
(set-module book module)adds an addional module to the book
adds an addional module to the book
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |