clindex.api

Liking cljdoc? Tell your friends :D

Clojure only.

all-ns-by-platform
all-projects-by-platform
db
db-conns
db-schema
effective-schema
index-project!
trackers-by-platform

The namespace intended to be required by clindex users.

Use index-project! for indexing any project and db for retrieveing datascript dbs by platform.

The namespace intended to be required by clindex users.

Use `index-project!` for indexing any project and `db` for retrieveing
datascript dbs by platform.

raw docstring

all-ns-by-platform^clj

all-projects-by-platform^clj

db^clj

(db platform)

Returns the datascript db index for the platform

Returns the datascript db index for the `platform`

raw docstring

db-conns^clj

db-schema^clj

(db-schema)

Returns the current dbs schema

Returns the current dbs schema

raw docstring

effective-schema^clj

index-project!^clj

(index-project! base-dir {:keys [platforms extra-schema on-new-facts] :as opts})

Goes over all Clojure[Script] files (depending on platforms) inside base-dir and index facts about the project and all its dependencies. Possible opts are :

:platforms (required), a set with the platforms to index, like #{:clj :cljs}
:extra-schema, a datascript schema that is going to be merged with clindex.schema/schema
:on-new-facts, a fn of one arg that will be called with new facts everytime a file inside base-dir project sources changes

Goes over all Clojure[Script] files (depending on platforms) inside `base-dir` and index facts about the project
and all its dependencies.
Possible `opts` are :
  - :platforms (required), a set with the platforms to index, like #{:clj :cljs}
  - :extra-schema, a datascript schema that is going to be merged with clindex.schema/schema
  - :on-new-facts, a fn of one arg that will be called with new facts everytime a file inside `base-dir` project sources changes

raw docstring