ufReference
API
Every export of every @uniflowed/* package, as the package declares it: the
signature, the comment above it, and the specifier a program imports it from.
These pages are written from the source when the site is built, by
uf doc and the packages' exports, so a signature
here is the signature in the code. What they do not have is the argument —
why a package is shaped the way it is — which is what the guides are for.
An export with no doc comment is listed under Without a doc comment on its package's page, with a link to where it is declared, rather than left out. The last column below counts the ones that have one.
| Package | What it is | Exports |
|---|---|---|
@uniflowed/brand | Flow declarations for @uniflowed/brand, part of the Unified Toolchain for Flow. | 0 of 9 |
@uniflowed/cell | Fine-grained reactivity: state, derived values, effects and resources, part of the Unified Toolchain for Flow. | 13 of 21 |
@uniflowed/config | Flow declarations for @uniflowed/config, part of the Unified Toolchain for Flow. | 10 of 17 |
@uniflowed/core | Shared native-runtime bridge for the Unified Toolchain for Flow (React). | 37 of 58 |
@uniflowed/effect | Flow implementation for @uniflowed/effect, part of the Unified Toolchain for Flow. | 138 of 141 |
@uniflowed/fetch | Typed HTTP over the platform fetch, part of the Unified Toolchain for Flow. | 6 of 7 |
@uniflowed/form | Forms that do not re-render: uncontrolled fields, narrow subscriptions and schema validation, part of the Unified Toolchain for Flow. | 52 of 71 |
@uniflowed/graphql | The Relay environment, without the boilerplate, for the Unified Toolchain for Flow. | 4 of 6 |
@uniflowed/hooks | The React hooks an application writes anyway, prerender-safe, part of the Unified Toolchain for Flow. | 96 of 96 |
@uniflowed/host | Running Flow on a Capability JS Host, with no bundler in the way. | 41 of 44 |
@uniflowed/i18n | Type-safe internationalisation on MessageFormat 2: a message's arguments are checked at the call, part of the Unified Toolchain for Flow. | 44 of 48 |
@uniflowed/immer | Draft-based immutable updates for Flow React apps, part of the Unified Toolchain for Flow. | 31 of 42 |
@uniflowed/mock | MSW-compatible request mocking over the platform's own fetch, part of the Unified Toolchain for Flow. | 21 of 21 |
@uniflowed/query | A query cache with de-duplication, structural sharing and stale-while-revalidate, part of the Unified Toolchain for Flow. | 43 of 55 |
@uniflowed/react | React, re-exported by name with its Flow types, for the Unified Toolchain for Flow. | 1 of 2 |
@uniflowed/react-native | React Native, re-exported for the Unified Toolchain for Flow. | 0 of 1 |
@uniflowed/react-native-testing | Native component tests and renderer-independent tree queries for Flow. | 0 of 26 |
@uniflowed/react-testing | React Testing Library over a real DOM, part of the Unified Toolchain for Flow. | 19 of 19 |
@uniflowed/relay | Relay, re-exported by name, for the Unified Toolchain for Flow (React). | 0 of 41 |
@uniflowed/router | The file-system router for Flow React applications: matching, layouts, loaders, navigation, server rendering and hydration. | 114 of 201 |
@uniflowed/server | Request-scoped server functions for the Unified Toolchain for Flow (React). | 275 of 282 |
@uniflowed/state | Atoms and the React binding for @uniflowed/state, part of the Unified Toolchain for Flow. | 53 of 58 |
@uniflowed/story | Named, rendered states of a component that a person and a test can both reach, part of the Unified Toolchain for Flow. | 33 of 34 |
@uniflowed/stylex | Flow declarations for @uniflowed/stylex, part of the Unified Toolchain for Flow. | 32 of 36 |
@uniflowed/temporal | Temporal, with uf's clock and a native-runtime calendar seam, for the Unified Toolchain for Flow. | 2 of 12 |
@uniflowed/test | The test API and worker for `uf test`: describe/it, a full matcher set, and the process uf fans test files out to. | 41 of 50 |
@uniflowed/testing | The test API under its other name: every binding re-exported from @uniflowed/test. | 0 of 24 |
@uniflowed/tui | A React renderer whose host is a terminal, following OpenTUI, for the Unified Toolchain for Flow. | 117 of 117 |
@uniflowed/ui | Headless, accessible React components whose composition Flow checks, part of the Unified Toolchain for Flow. | 105 of 337 |
@uniflowed/validator | Schemas that parse rather than assert: typed inference, issue paths and JSON Schema export, part of the Unified Toolchain for Flow. | 104 of 115 |
@uniflowed/vite | Vite, driven by uf.config.js: every Flow module through `uf transform`, MDX, the file-system router and static rendering as Vite plugins. | 4 of 9 |
@uniflowed/web | The primitives a web page is built from, for the Unified Toolchain for Flow. | 43 of 43 |
Edit this pagedocs/app/reference/api/$page.mdx