Liking cljdoc? Tell your friends :D

std.lang.base.book


*dep-types*clj


*skip-check*clj


assert-compatible-langclj

(assert-compatible-lang book lang)

asserts that the lang is compatible

asserts that the lang is compatible
raw docstring

assert-entryclj

(assert-entry book module-id section symbol-id)

asserts that module exists

asserts that module exists
raw docstring

assert-moduleclj

(assert-module book module-id)

asserts that module exists

asserts that module exists
raw docstring

bookclj

(book {:keys [lang meta grammar modules parent merged] :as m})

creates a book

creates a book
raw docstring

book-entryclj

(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
raw docstring

book-entry?clj

(book-entry? x)

checks if object is a book entry

checks if object is a book entry
raw docstring

book-fromclj

(book-from snapshot lang)

returns the merged book given snapshot

returns the merged book given snapshot
raw docstring

book-mergeclj

(book-merge book parent)

merges a book with it's parent

merges a book with it's parent
raw docstring

book-metaclj

(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?
raw docstring

book-meta?clj

(book-meta? x)

checks if object is a book meta

checks if object is a book meta
raw docstring

book-moduleclj

(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
raw docstring

book-module?clj

(book-module? x)

checks of object is a book module

checks of object is a book module
raw docstring

book-stringclj

(book-string {:keys [lang meta grammar modules parent scope]})

shows the book string

shows the book string
raw docstring

book?clj

(book? obj)

checks that object is a book

checks that object is a book
raw docstring

check-compatible-langclj

(check-compatible-lang book lang)

checks if the lang is compatible with the book

checks if the lang is compatible with the book
raw docstring

delete-entryclj

(delete-entry book module-id section symbol-id)

deletes an entry

deletes an entry
raw docstring

delete-moduleclj

(delete-module book module-id)

deletes a module given a book

deletes a module given a book
raw docstring

delete-modulesclj

(delete-modules book module-ids)

deletes all modules

deletes all modules
raw docstring

get-base-entryclj

(get-base-entry {:keys [modules] :as book} module-id id section)

gets an entry in the book

gets an entry in the book
raw docstring

get-code-depsclj

(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
raw docstring

get-code-entryclj

(get-code-entry {:keys [modules] :as book} id)

gets a code entry in the book

gets a code entry in the book
raw docstring

get-depsclj

(get-deps {:keys [modules] :as book} id)

get dependencies for a given id

get dependencies for a given id
raw docstring

get-deps-nativeclj

(get-deps-native {:keys [modules] :as book} id)

get dependencies for a given id

get dependencies for a given id
raw docstring

get-entryclj

(get-entry {:keys [modules] :as book} id)

gets either the module or code entry

gets either the module or code entry
raw docstring

get-fragment-entryclj

(get-fragment-entry {:keys [modules] :as book} id)

gets a code entry in the book

gets a code entry in the book
raw docstring

get-moduleclj

(get-module {:keys [modules] :as book} id)

gets the module

gets the module
raw docstring

has-entry?clj

(has-entry? book module-id section symbol-id)

checks that book has an entry

checks that book has an entry
raw docstring

has-module?clj

(has-module? book module-id)

checks that a books has a given module

checks that a books has a given module
raw docstring

list-entriesclj

(list-entries book)
(list-entries {:keys [modules]} dep-types)

lists entries for a given symbol

lists entries for a given symbol
raw docstring

module-createclj

(module-create {:keys [lang] :as book} module-id options)

creates a module given book and options

creates a module given book and options
raw docstring

module-create-checkclj

(module-create-check {:keys [modules] :as book} module-id link)

checks that bundles are available

checks that bundles are available
raw docstring

module-create-filenameclj

(module-create-filename book module-id)

creates a filename for module

creates a filename for module
raw docstring

module-create-requiresclj

(module-create-requires require)

creates a map for the requires

creates a map for the requires
raw docstring

put-entryclj

(put-entry book entry)

updates entry value in the book

updates entry value in the book
raw docstring

put-moduleclj

(put-module book module)

adds or updates a module

adds or updates a module
raw docstring

set-entryclj

(set-entry book entry)

sets entry in the book

sets entry in the book
raw docstring

set-moduleclj

(set-module book module)

adds an addional module to the book

adds an addional module to the book
raw 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