API Reference

A complete index of public exports, grouped by package. The icon on the left of each name shows the kind of symbol: ƒ function, ⌘ component, T TypeScript type, ∙ constant. The link icon on the right opens the page with full signature and examples.

Core runtime

@triggery/core/ — runtime, indexed dispatch, scheduler, inspector, middleware
- ƒ createCheck
- ƒ createInspector
- ƒ createRuntime
- ƒ createScheduler
- ƒ createTrigger
- ƒ getDefaultRuntime
- ƒ setDefaultRuntime
- T ActionContext
- T ActionFn
- T ActionHook
- T ActionKey
- T ActionMap
- T ActionsCtx
- T CascadeContext
- T CheckCtx
- T ConcurrencyStrategy
- T ConditionGetter
- T ConditionHook
- T ConditionKey
- T ConditionMap
- T ConditionsCtx
- T CreateTriggerConfig
- T EmptyRecord
- T EventHook
- T EventKey
- T EventMap
- T EventOf
- T FireContext
- T InspectorImpl
- T InternalHandlerCtx
- T InternalTriggerConfig
- T MatchContext
- T MetaCtx
- T Middleware
- T NamedHooks
- T RegisterScopeOptions
- T RegistrationToken
- T Runtime
- T RuntimeGraph
- T RuntimeOptions
- T SchedulerImpl
- T SchedulerStrategy
- T SkipContext
- T Task
- T ToPascal
- T Trigger
- T TriggerConfig
- T TriggerCtx
- T TriggerGraphNode
- T TriggerHandler
- T TriggerInspectSnapshot
- T TriggerSchema
- T UntypedActionFn

Framework bindings

@triggery/react/ — React 18+/19 hooks + providers
- ƒ createNamedHooks
- ƒ useAction
- ƒ useCondition
- ƒ useEvent
- ƒ useInlineTrigger
- ƒ useInspect
- ƒ useInspectHistory
- ƒ useRuntime
- ƒ useScope
- ⌘ TriggerRuntimeContext
- ⌘ TriggerRuntimeProvider
- ⌘ TriggerScope
- ⌘ TriggerScopeContext
- T TriggerRuntimeProviderProps
- T TriggerScopeProps
- T UseInlineTriggerConfig
@triggery/solid/ — SolidJS bindings, native reactivity
- ƒ useAction
- ƒ useCondition
- ƒ useEvent
- ƒ useInlineTrigger
- ƒ useInspect
- ƒ useInspectHistory
- ƒ useRuntime
- ƒ useScope
- ⌘ RuntimeContext
- ⌘ ScopeContext
- ⌘ TriggerRuntimeProvider
- ⌘ TriggerScope
- T UseInlineTriggerConfig
@triggery/vue/ — Vue 3 Composition API bindings
- ƒ provideTriggerRuntime
- ƒ provideTriggerScope
- ƒ useAction
- ƒ useCondition
- ƒ useEvent
- ƒ useInlineTrigger
- ƒ useInspect
- ƒ useInspectHistory
- ƒ useRuntime
- ƒ useScope
- ∙ RUNTIME_KEY
- ∙ SCOPE_KEY
- ⌘ TriggerRuntimeProvider
- ⌘ TriggerScope
- T UseInlineTriggerConfig

Testing

@triggery/testing/ — headless runtime + fake scheduler + mocks
- ƒ createFakeScheduler
- ƒ createTestRuntime
- T FakeScheduler
- T TestRuntime
- T TestRuntimeOptions

Tooling

@triggery/vite/ — auto-import every *.trigger.ts
- ƒ triggery
- T TriggeryViteOptions
@triggery/cli/ — create / scaffold / graph / lint
- ƒ buildTriggerGraph
- ƒ createProject
- ƒ isKnownTemplate
- ƒ renderGraph
- ƒ runLint
- ƒ scaffoldTrigger
- T CreateProjectOptions
- T CreateProjectResult
- T GraphFormat
- T GraphOptions
- T LintOptions
- T ScaffoldTriggerOptions
- T TemplateName
- T TriggerNode
@triggery/codemod/ — ts-morph codemods
- ƒ extractTrigger
- ƒ migrateFromListenerMiddleware
- T ExtractTriggerOptions
- T ExtractTriggerResult
- T MigratedListener
- T MigrateFromListenerMiddlewareOptions
- T MigrateFromListenerMiddlewareResult
@triggery/eslint-plugin/ — 8 rules + recommended / strict
- ƒ recommended
- ƒ rules
- ƒ strict

State / event adapters

@triggery/redux/ — Redux selectors as conditions
- ƒ useReduxCondition
- T ReduxStoreLike
@triggery/zustand/ — Zustand slices as conditions
- ƒ useZustandCondition
- T ZustandStoreLike
@triggery/jotai/ — Jotai atoms as conditions
- ƒ useJotaiCondition
- T JotaiAtomLike
- T JotaiStoreLike
@triggery/mobx/ — MobX observables as conditions
- ƒ useMobxCondition
@triggery/signals/ — preact-signals / alien-signals
- ƒ useSignalCondition
- T SignalLike
@triggery/reatom/ — Reatom v3 atoms as conditions
- ƒ useReatomCondition
- T ReatomReadableLike
@triggery/query/ — TanStack Query cache lookups
- ƒ useQueryCondition
- T QueryClientLike
@triggery/dom/ — DOM events + ResizeObserver + IntersectionObserver
- ƒ useDomEvent
- ƒ useIntersectionObserver
- ƒ useResizeObserver
- T DomEventTarget
- T UseDomEventOptions
- T UseIntersectionObserverOptions
- T UseResizeObserverOptions
@triggery/socket/ — socket.io-client + native WebSocket
- ƒ useSocketIoEvent
- ƒ useWebSocketEvent
- T SocketIoLike
- T UseSocketIoEventOptions
- T UseWebSocketEventOptions
- T WebSocketLike

DevTools

@triggery/devtools-redux/ — Redux DevTools middleware
- ƒ reduxDevtoolsMiddleware
- T DevtoolsHistoryEntry
- T DevtoolsReduxOptions
- T DevtoolsState
@triggery/devtools-panel/ — InspectorView for in-app debug UIs
- ⌘ InspectorView
- ⌘ TriggerSnapshotView
- T InspectorViewProps
- T TriggerSnapshotViewProps
@triggery/devtools-bridge/ — page-side bridge for external panels
- ƒ installDevtoolsBridge
- ∙ DEVTOOLS_GLOBAL_KEY
- ∙ DEVTOOLS_SOURCE
- T DevtoolsBridgeOptions
- T DevtoolsMessage