API reference
Every export of every package, with its exact signature. These pages are generated from the published type declarations, so they match what your editor shows.
For examples, gotchas and the reasoning behind each API, read the guide or API.md.
| Package | What it is |
|---|---|
| @kontsedal/olas-core | Olas core — controller-tree state management with signals, queries, mutations, and forms. Framework-agnostic. |
| @kontsedal/olas-codemod | Codemod for upgrading an Olas app from 0.8 to 1.0: the renames, the root handle, required ids, plugin meta and the new async contexts, with a TODO list for what needs a human. |
| @kontsedal/olas-cross-tab | Olas cross-tab cache sync — a BroadcastChannel-backed plugin that keeps every browser tab's query cache in step. |
| @kontsedal/olas-devtools | Olas in-app devtools — controller tree inspector, cache timeline, mutation log, signal graph. |
| @kontsedal/olas-entities | Entity-normalization plugin for Olas — extract entities from query results, subscribe per-id, patch every query holding an entity in one call. |
| @kontsedal/olas-eslint-plugin | ESLint rules for Olas apps: no React hooks in controllers, definitions at module scope, synchronous factories, the optimistic-write recipe, test helpers kept in tests, and abort signals passed on. |
| @kontsedal/olas-mutation-queue | Olas mutation queue — durable persistence + reload-safe replay for persistable mutations. |
| @kontsedal/olas-persist | Olas persistence — createPersisted and persistQueryCachePlugin over localStorage and IndexedDB (indexedDbAdapter) storage adapters. |
| @kontsedal/olas-react | Olas React adapter — OlasProvider, useRoot, useValue, useQuery, useField, useMutation, SuspendOnUnmount, SSR hydration and streaming. |
| @kontsedal/olas-realtime | Olas realtime composables — createRealtimePatcher, createLiveStream and createConnectionState over a pluggable RealtimeService. |
| @kontsedal/olas-router | Olas router bridge — scopes + a generic Bridge component for wiring any client-side router (TanStack Router, React Router v6) into the controller tree. |
| @kontsedal/olas-svelte | Olas Svelte adapter — setRoot/getRoot context and store views over queries, fields and mutations. Olas signals are Svelte stores as they are. |
| @kontsedal/olas-vue | Olas Vue adapter — olasPlugin, useRoot, useValue, useQuery, useInfiniteQuery, useField, useMutation. |
| @kontsedal/olas-zod | Olas Zod integration — zodValidator and createZodForm for end-to-end typed forms. |