Skip to content

TypeScript API reference

typedoc output for the desktop frontend under src/, built with every file treated as a navigable module. Like the Rust reference this is a code-navigation aid for contributors, not an external API contract.

TIP

The reference opens in a separate page. Use your browser's back button to return here.

Open TypeScript API reference →

What's in there

  • lib/ helpersa11y, app-suggestions, break-mode, clock-list, color, platform, screen-time, sounds, stats-format, time, tray-countdown.
  • Settings viewviews/settings/ with its tabs/, hooks/, and components/ subtrees, plus constants, types, and utils.
  • Break overlayviews/break-overlay.
  • App shellApp, error-boundary, main.

Building it locally

sh
npm install
npm run doc

Output lands in target/typedoc/. CI builds the same target and copies it under /api/ts/ in the published site.

Source

github.com/drmowinckels/entracte/tree/main/src — JSDoc / TSDoc comments live directly above each export.

Released under the Apache 2.0 License.