Kandra

API reference

This site does not duplicate the exhaustive, generated signature reference — that's what Dokka is for, and it's generated directly from source on every tag, so it's never out of date with itself. What this site adds is the part Dokka can't: why a given annotation or method exists, when to reach for it, and what breaks if you don't.

Kandra version this site tracks

This site's prose and code examples are verified against Kandra v0.4.6 (the current source — the latest tag on main in the Kandra repo). The published Dokka site currently serves v0.4.6

— caught up, no gap right now. Dokka publishing is a separate step from tagging a release, so this can fall behind again; if it has, trust this site's description of why over a stale Dokka signature.

How to use this section

  • /modules is the curated companion reference — one page per module, every public annotation/class/function with a real example, a "why this module exists separately" section, and gotchas pulled from real source comments and issue reports.
  • /recipes is task-oriented — "how do I do X," not "what does class Y expose."
  • /battle-scars is where a class or method's behavior was the subject of a real, root-caused bug — worth reading before you rely on that part of the API in something that matters.
  • Dokka (linked from every module and class page on this site) is the exhaustive signature source of truth — every parameter, every overload, every inherited member.

Modules

ModuleCurated referenceDokka
kandra-bom/modules/kandra-bomDokka →
kandra-core/modules/kandra-coreDokka →
kandra-runtime/modules/kandra-runtimeDokka →
kandra-ktor/modules/kandra-ktorDokka →
kandra-koin/modules/kandra-koinDokka →
kandra-kodein/modules/kandra-kodeinDokka →
kandra-codegen/modules/kandra-codegenDokka →
kandra-test/modules/kandra-testDokka →
kandra-multidc/modules/kandra-multidcDokka →
kandra-migrate/modules/kandra-migrateDokka →
kandra-jakarta/modules/kandra-jakartaDokka →