API Reference
•1 min read
API Reference
Comprehensive reference documentation for every public export in Directive.
Reference Sections
| Section | Page | Contents |
|---|---|---|
| Core API | createModule, createSystem, t, module, Backoff, and all core factory functions | |
| Types | ModuleSchema, Plugin, System, Requirement, and all TypeScript type definitions | |
| React Hooks | useFact, useDerived, useSelector, useEvents, and all React adapter exports | |
| Vue Composables | useFact, useDerived, useSelector, useEvents, and all Vue adapter exports | |
| Svelte Hooks | useFact, useDerived, useSelector, useEvents, and all Svelte adapter exports | |
| Solid Hooks | useFact, useDerived, useSelector, useEvents, and all Solid adapter exports | |
| Lit Controllers | DerivedController, FactController, InspectController, and all Lit adapter exports |
Import Paths
| Path | Contents |
|---|---|
@directive-run/core | Core API – modules, systems, type builders, constraint/resolver helpers |
@directive-run/react | React hooks and components |
@directive-run/vue | Vue composables |
@directive-run/svelte | Svelte stores |
@directive-run/solid | Solid signals |
@directive-run/lit | Lit controllers |
@directive-run/core/plugins | Built-in plugins (logging, devtools, persistence) |
@directive-run/core/testing | Test utilities (mock resolvers, fake timers, assertions) |
@directive-run/ai | AI agent orchestration, guardrails, streaming, constraint builders |
@directive-run/core/worker | Web Worker adapter |
Next Steps
- Core API Reference – Start here for the main
@directive-run/coreexports - Type Definitions – All TypeScript interfaces and types
- React Hooks – React adapter hooks reference
- Vue Composables – Vue adapter composables reference
- Svelte Hooks – Svelte adapter hooks reference
- Solid Hooks – Solid adapter hooks reference
- Lit Controllers – Lit adapter controllers reference
