Liking cljdoc? Tell your friends :D
ClojureScript only.

cargo.api

build-wasmcljs

(build-wasm cfg)

Builds a wasm project but with the extra steps of exec'ing wasm-gc on the build artifact and returning it as an uninstantiated buffer

  • Compiler warnings may still be present in a successful result => pchan<[?err ?{:buffer js/Buffer, ...}]>
Builds a wasm project but with the extra steps of exec'ing wasm-gc on the
build artifact and returning it as an uninstantiated buffer
  + Compiler warnings may still be present in a successful result
=> pchan<[?err ?{:buffer js/Buffer, ...}]>
sourceraw docstring

build-wasm-localcljs

(build-wasm-local cfg)
(build-wasm-local cfg importOptions)

Build and instantiate modules local to the build nodejs process.

  • Compiler warnings may still be present in a successful result => pchan<[?err ?instantiated-module]>
Build and instantiate modules local to the build nodejs process.
  + Compiler warnings may still be present in a successful result
=> pchan<[?err ?instantiated-module]>
sourceraw docstring

cargo-buildcljs

(cargo-build cfg)

Builds the artifact described by the config

  • Compiler warnings may still be present in a successful result => pchan<[?err ?ok]>
Builds the artifact described by the config
  + Compiler warnings may still be present in a successful result
=> pchan<[?err ?ok]>
sourceraw docstring

cargo-runcljs

(cargo-run cfg)

Builds and then runs src/bin/main.rs or main.rs.

  • Not applicable to wasm targets
  • Compiler warnings may still be present in a successful result
  • If your process emits json it will automatically be converted to edn under the ok's :stdout key => pchan<[?err ?ok]>
Builds and then runs src/bin/main.rs or main.rs.
  + Not applicable to wasm targets
  + Compiler warnings may still be present in a successful result
  + If your process emits json it will automatically be converted to edn
    under the ok's :stdout key
=> pchan<[?err ?ok]>
sourceraw docstring

cargo-testcljs

(cargo-test cfg)

Run cargo's built-in test runner.

  • $cargo test leaves alot to be desired:
    • It suppresses output during builds
    • it obscures logging during tests (supposedly theres a --nocapture flag but cant get it to work)
    • there is no structured (json) test result output.
  • Compiler warnings may still be present in a successful result => pchan<[?err ?ok]>
Run cargo's built-in test runner.
 + `$cargo test` leaves alot to be desired:
   - It suppresses output during builds
   - it obscures logging during tests (supposedly theres a --nocapture flag but cant get it to work)
   - there is no structured (json) test result output.
 + Compiler warnings may still be present in a successful result
=> pchan<[?err ?ok]>
sourceraw docstring

clean-projectcljs

(clean-project cfg)

delete compiled artifacts

delete compiled artifacts
sourceraw docstring

get-errorscljs

(get-errors)

errors from last build

errors from last build
sourceraw docstring

get-stderrcljs

(get-stderr)

stderr from last build

stderr from last build
sourceraw docstring

get-stdoutcljs

(get-stdout)

should be stdout emitted from your app on last run/test

should be stdout emitted from your app on last run/test
sourceraw docstring

get-warningscljs

(get-warnings)

warnings from last build

warnings from last build
sourceraw docstring

last-resultcljs

(last-result)
source

render-errorscljs

(render-errors)
(render-errors errors)
source

render-warningscljs

(render-warnings)
(render-warnings warnings)
source

report-errorcljs

(report-error err)
source

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close