All Modules
Every module page, grouped the same way as the sidebar. Add one dependency, "org.wvlet.uni" %% "uni" (Installation), and all of these are available unless a row says otherwise.
Core
| Page | Description |
|---|---|
| Design | Object wiring with lifecycle management |
| Logging | Logging with source locations through LogSupport |
| Type Introspection | Compile-time type information with Surface |
| Result | A value that may have failed, with a typed error channel |
| SettingStore | User settings that survive restarts, as an RxVar |
| Utilities | IDs (UUIDv7, ULID, NanoId), encodings, value types, and timing |
Data & Serialization
| Page | Description |
|---|---|
| Weaver | JSON, MessagePack, and Map codecs from one derives Weaver |
| JSON | Pure-Scala JSON parser, JSONValue tree, and query DSL |
| MessagePack | Compact binary serialization |
| YAML | YAML 1.2 parser with Weaver decoding and frontmatter |
| Markdown | CommonMark + GFM parser and safe HTML renderer |
| Cron | Cron expressions with next-run times and English descriptions |
Files & Memory
| Page | Description |
|---|---|
| IO | One entry point for file operations and subprocesses |
| FileSystem | Cross-platform file I/O with IOPath |
| Canvas (Off-Heap Memory) | Memory buffers larger than 2 GB, addressed by Long offsets |
Reactive Streams (Rx)
| Page | Description |
|---|---|
| Overview | What Rx and RxVar are and when to use them |
| Rx Basics | Creating and subscribing to streams |
| Stream Operators | Transforming and combining streams |
| Rx Concurrency | RxRef, RxDeferred, fibers, and semaphores |
Control Flow
| Page | Description |
|---|---|
| Overview | Handling failures and managing resources |
| Retry Logic | Retry with backoff strategies |
| Circuit Breaker | Stop calling a failing service |
| Rate Limiter | Throttle operation throughput (JVM) |
| Caching | TTL and LRU caches |
| Resource Management | Acquire and release resources safely |
| Background Task | Cancellable background work you can poll for progress |
HTTP & RPC
| Page | Description |
|---|---|
| Overview | The cross-platform HTTP stack at a glance |
| HTTP Client | Sync and async HTTP clients |
| REST Server | HTTP server on Netty, Node.js, or Scala Native |
| Router | Type-safe route definitions |
| RPC | Scala traits as remote services, with generated clients |
| OpenAPI | OpenAPI 3.0 documents from @Endpoint routes |
| Server-Sent Events | One-way server-to-client streaming |
| WebSocket Client | Cross-platform bidirectional WebSocket client |
| HTTP Retry Strategies | Automatic retry for transient HTTP failures |
| MCP Server (stdio) | A Scala trait as an MCP server that AI agents call as tools |
CLI
| Page | Description |
|---|---|
| Overview | Building command-line applications |
| Terminal Styling | Colored terminal output with Tint |
| Progress Indicators | Progress bars and spinners |
| Line Editing | Line editing, history, and completion for REPLs |
| Command Launcher | Type-safe command-line argument parsing |
Testing & Build
| Page | Description |
|---|---|
| UniTest | Lightweight cross-platform test framework (uni-test) |
| sbt-uni Plugin | RPC client generation and other build tasks |
| sbt-uni-playwright Plugin | Run Scala.js tests in a real browser |
| sbt-uni-crossproject Plugin | Cross-build for JVM, Scala.js, and Scala Native |
| sbt-uni-javadoc Plugin | Keep published -javadoc.jar files small |
Web UI (Scala.js)
Browser and desktop UIs have their own section: start at Web UI, which covers uni-dom, the uni-ui components (uni-ui), and Electron desktop apps.