ufReference
Reference
For a reader who knows what they are looking for. Each page is the whole of one surface — every flag and exit code, every config key and its default, every package and what it exports — and the guides link into it rather than repeating it.
Which page answers which question
| You want to know | Page |
|---|---|
| what a flag does, and what a command exits with | Commands |
what a key in uf.config.js defaults to, and what reads it | uf.config.js |
which @uniflowed/* package something is in, and whether it is on npm | Packages |
| what parts a component has, and which keys it owns | Components |
| what a browser hook renders before hydration | Browser hooks |
what @uniflowed/effect exports, and what Flow cannot say about it | Effects |
| how a message is written, typed and matched to a locale | Internationalisation |
| which parts of Go's standard library have a Flow counterpart | Standard library |
The pages
- CommandsEvery subcommand, flag and exit code.
- uf.config.jsEvery option, its default, and what reads it.
- PackagesWhat each @uniflowed/* package is for.
- ComponentsThe headless primitives, their parts, and the keys each one owns.
- Browser hooksWhat each one renders before hydration, and how the ones with no server answer say so.
- EffectsTyped failures, fibers that own what they start, and what Flow cannot say.
- InternationalisationMessageFormat 2 with typed arguments, the subset uf implements, and where the type system stops.
- Standard libraryThe Go standard library modules JavaScript does not have, and the measurements behind why they are JavaScript.
When a reference page is not enough
A reference page says what exists; it does not say which of it you need. If you arrived with a task rather than a name, the guide for it is one of the paths on the home page: Build an app for application code, The toolchain for the commands, Targets for where it runs.