Liking cljdoc? Tell your friends :D

fastester.core

Run performance benchmarks and create displays of those measurements.

High-level workflow:

  1. Set options.
  2. Write benchmarks with [[defbench]].
  3. Run benchmarks with [[run-benchmarks]].
  4. Generate html document with [[generate-documents]].
Run performance benchmarks and create displays of those measurements.

High-level workflow:

1. Set options.
2. Write benchmarks with [[defbench]].
3. Run benchmarks with [[run-benchmarks]].
4. Generate html document with [[generate-documents]].
raw docstring

-mainclj

(-main action)
(-main action explicit-options-filename)

Given keyword action, runs a Fastester task with the following mappings:

  • :benchmarks executes ([[run-benchmarks]])
  • :documents executes ([[generate-documents]]).

Examples:

$ lein run -m fastester.core :benchmarks
$ lein run -m fastester.core :documents

Read options from ./resources/fastester_options.edn because explicit options filename is not supplied.

Example:

$ lein run -m fastester.core :benchmarks ./foobar_options.edn

Reads options from explicitly-given ./foobar_options.edn.

Given keyword `action`, runs a Fastester task with the following mappings:

* `:benchmarks` executes `(`[[run-benchmarks]]`)`
* `:documents` executes `(`[[generate-documents]]`)`.

Examples:
```bash
$ lein run -m fastester.core :benchmarks
$ lein run -m fastester.core :documents
```

Read options from `./resources/fastester_options.edn` because explicit options
filename is not supplied.

Example:
```bash
$ lein run -m fastester.core :benchmarks ./foobar_options.edn
```

Reads options from explicitly-given `./foobar_options.edn`.
sourceraw docstring

run-benchmarks-and-generate-documentsclj

(run-benchmarks-and-generate-documents)
(run-benchmarks-and-generate-documents explicit-options-filename)

Run all benchmarks and generate an html document that displays comparisons to previous versions.

See [[run-benchmarks]] and [[generate-documents]].

Run all benchmarks and generate an html document that displays comparisons to
previous versions.

See [[run-benchmarks]] and [[generate-documents]].
sourceraw 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