Documentation
API Packages
core
- cache
- errors
- utils
- Function: asDisposable()
- Class: BaseError
- @xmachines/core
- Function: createLruCache()
- Function: createNullRecord()
- Function: createWarnOnce()
- Function: describeValue()
- Variable: DISPOSE
- Class: DisposeConflictError
- Type Alias: DisposeKey
- Type Alias: DisposeMember
- Function: isError()
- Function: isThenable()
- Interface: KeyValueCache<V>
- Function: releaseQuietly()
- Function: rethrowLater()
- Function: safeString()
- Function: shallowEqualExcept()
play
play-atom
- Type Alias: AnyAtom
- Interface: AsyncAtomOptions
- Type Alias: AsyncAtomState<TData, TError>
- Interface: Atom<T>
- Interface: AtomObserver<T>
- Interface: AtomOptions<T>
- Interface: AtomSubscription
- Interface: BaseAtom<T>
- Variable: createAsyncAtom
- Interface: CreateAtom()
- Variable: createAtom
- Variable: createWritableAtom
- @xmachines/play-atom
- Interface: Readable<T>
- Interface: ReadonlyAtom<T>
- Function: watchAtom()
play-dom
- Type Alias: ActionFn<C, K>
- Type Alias: Actions<C>
- Type Alias: BaseComponentProps<P>
- Type Alias: CatalogHasActions<C>
- Interface: ComponentContext<C, K>
- Type Alias: ComponentFn<C, K>
- Type Alias: ComponentRegistry<C>
- Type Alias: ConfirmHandler
- Function: createPlayUI()
- Interface: CreatePlayUIOptions
- Function: createRenderer()
- Function: createValidationRegistry()
- Function: defineRegistry()
- Type Alias: DefineRegistryOptions<C>
- Interface: DefineRegistryResult
- Type Alias: DomComponentRenderer
- Type Alias: DomRegistry
- Interface: DomRenderContext
- Type Alias: DomSchema
- Interface: EventHandle
- Interface: FieldValidationState
- Type Alias: MountFn
- Interface: MountOptions
- Type Alias: OnRenderError
- Interface: PassOptions
- @xmachines/play-dom
- Interface: PlayDomOptions
- Class: PlayRenderer
- Type Alias: RenderErrorHandler
- Interface: RenderErrorInfo
- Type Alias: RenderErrorKind
- Function: renderSpec()
- Interface: RenderSpecOptions
- Variable: schema
- Type Alias: SetState
- Interface: UIProviderOptions
- Interface: ValidationRegistry
play-dom-router
- Interface: BasePathOptions
- Interface: BrowserHistory
- Interface: BrowserWindow
- Function: connectRouter()
- Interface: ConnectRouterOptions
- Function: createBrowserHistory()
- Function: createRouter()
- Class: DomRouterBridge
- @xmachines/play-dom-router
- Interface: PlayRouteEvent
- Interface: RoutableActor
- Interface: RouteLookupContract
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Interface: RouterConnection()
- Interface: VanillaRouter
play-pattern
- Function: buildPath()
- Function: createLruCache()
- Function: getIndexKey()
- Interface: GroupPart
- Function: isDotSegment()
- Interface: KeyValueCache<V>
- Interface: LiteralPart
- Interface: ParamPart
- Interface: ParsedPattern
- Interface: ParseOptions
- Function: parsePattern()
- Type Alias: PathBuildResult
- Type Alias: PathParams
- Type Alias: PatternModifier
- Interface: PatternParam
- Type Alias: PatternPart
- @xmachines/play-pattern
play-react
- Function: ActionProvider()
- Interface: ActionProviderProps
- Variable: ActorProvider
- Interface: ActorProviderProps
- Type Alias: AnyPlayActor
- Interface: ComponentContext<C, K>
- Type Alias: ComponentFn<C, K>
- Function: defineRegistry()
- Interface: DefineRegistryResult
- Function: JSONUIProvider()
- Interface: JSONUIProviderProps
- Type Alias: OnRenderError
- @xmachines/play-react
- Class: PlayErrorBoundary
- Interface: PlayErrorBoundaryProps
- Interface: PlayErrorBoundaryState
- Variable: PlayRenderer
- Variable: PlayUIProvider
- Interface: PlayUIProviderProps
- Function: Renderer()
- Interface: RendererProps
- Type Alias: RenderErrorHandler
- Interface: RenderErrorInfo
- Type Alias: RenderErrorKind
- Variable: schema
- Function: StateProvider()
- Interface: StateProviderProps
- Function: useActor()
- Function: useAtomEffect()
- Function: useBoundProp()
- Function: useFieldValidation()
- Function: usePlayView()
- Function: ValidationProvider()
- Interface: ValidationProviderProps
- Interface: ViewContextValue
- Function: VisibilityProvider()
- Interface: VisibilityProviderProps
play-react-router
- Function: createPlayRouterProvider()
- Function: createRouteMapFromTree()
- @xmachines/play-react-router
- Interface: PlayRouteEvent
- Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
- Variable: PlayRouterProvider
- Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
- Interface: PlayRouterProviderProps<TActor>
- Class: ReactRouterBridge
- Interface: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
play-router
- errors
- index
- xstate
- Interface: BasePathOptions
- Function: buildPlayRouteEvent()
- Interface: BuildPlayRouteEventOptions
- Function: buildRouteTree()
- Function: cleanFrameworkParams()
- Interface: CompileOptions
- Function: createLruCache()
- Function: createRouteMap()
- Function: createRouteMapFromTree()
- Function: createRouterConnection()
- Function: detectDuplicateRoutes()
- Class: DuplicateBridgeError
- Class: DuplicateRoutePathError
- Class: EmptyRoutePathError
- Function: extractMachineRoutes()
- Function: extractQuery()
- Function: extractRouteParams()
- Function: findRouteById()
- Function: findRouteByPath()
- Interface: FrameworkParamsSource
- Function: getNavigableRoutes()
- Function: getRoutableRoutes()
- Function: getRouteMappings()
- Function: getTransitionReachableRoutes()
- Class: InvalidBasePathError
- Class: InvalidRoutePatternError
- Class: InvalidStateIdError
- Function: isMountableBridge()
- Function: isRouteReachable()
- Function: joinBasePath()
- Interface: KeyValueCache<V>
- Interface: LocationLike
- Interface: MachineEdgeData
- Type Alias: MachineGraph
- Interface: MachineNodeData
- Function: machineToGraph()
- Class: MissingBasePathParamError
- Interface: MountableRouterBridge
- Function: mountKey()
- Variable: NO_BASE_PATH
- Function: normalizeBasePath()
- Function: openProviderBridge()
- Interface: OpenProviderBridgeArgs<TRouter, TActor>
- Interface: ParsedPattern
- Interface: ParseOptions
- Function: parsePattern()
- Function: pickOwnParams()
- @xmachines/play-router
- Interface: PlayRouteEvent
- Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
- Interface: PlayRouterProviderBaseProps<TRouter, TActor, TNode>
- Function: repointProviderBridge()
- Function: resolveBasePath()
- Interface: ResolvedBasePath
- Interface: ResolvedRoutePath
- Function: resolveFrameworkParams()
- Variable: ROOT_NODE_ID
- Interface: Routable
- Interface: RoutableActor
- Type Alias: RouteData
- Type Alias: RouteDataResolver
- Function: routeExists()
- Interface: RouteInfo
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouteMatch
- Type Alias: RouteMetadata
- Interface: RouteNode
- Interface: RouteObject
- Interface: RouterBridge
- Abstract Class: RouterBridgeBase
- Interface: RouterBridgeOptions
- Interface: RouterConnection()
- Class: RouterSyncError
- Interface: RouteTree<TGraph>
- Interface: RouteWatcherHandle
- Function: sanitizePathname()
- Function: splitLocation()
- Interface: SplitLocation
- Function: stripBasePath()
- Class: UnknownStateTypeError
- Type Alias: URLPatternLike
- Function: validateRouteFormat()
- Function: validateStateExists()
- Interface: WindowLike
play-solid
- Function: ActionProvider()
- Interface: ActionProviderProps
- Variable: ActorContext
- Variable: ActorProvider
- Interface: ActorProviderProps
- Type Alias: AnyPlayActor
- Interface: ComponentContext<C, K>
- Type Alias: ComponentFn<C, K>
- Type Alias: ComponentRegistry
- Function: defineRegistry()
- Interface: DefineRegistryResult
- Function: JSONUIProvider()
- Interface: JSONUIProviderProps
- Type Alias: OnRenderError
- @xmachines/play-solid
- Variable: PlayRenderer
- Variable: PlayUIProvider
- Interface: PlayUIProviderProps
- Function: Renderer()
- Interface: RendererProps
- Type Alias: RenderErrorHandler
- Interface: RenderErrorInfo
- Type Alias: RenderErrorKind
- Variable: schema
- Type Alias: SetState
- Function: StateProvider()
- Interface: StateProviderProps
- Function: useAction()
- Function: useActions()
- Function: useActor()
- Function: useBoundProp()
- Function: useFieldValidation()
- Function: useIsVisible()
- Function: useOptionalValidation()
- Function: usePlayView()
- Function: useStateBinding()
- Function: useStateStore()
- Function: useStateValue()
- Function: useVisibility()
- Function: ValidationProvider()
- Interface: ValidationProviderProps
- Interface: ViewContextValue
- Function: VisibilityProvider()
- Type Alias: VisibilityProviderProps
play-solid-router
- Function: createPlayRouterProvider()
- @xmachines/play-solid-router
- Interface: PlayActor<TSnapshot, TEvent>
- Interface: PlayRouteEvent
- Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
- Variable: PlayRouterProvider
- Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
- Interface: PlayRouterProviderProps<TActor>
- Interface: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Class: SolidRouterBridge
- Type Alias: SolidRouterHooks
play-svelte
- Type Alias: ActionFn<C, K>
- Type Alias: Actions<C>
- Interface: ActorProviderProps
- Type Alias: AnyPlayActor
- Interface: BaseComponentProps<P>
- Interface: ComponentContext<C, K>
- Type Alias: ComponentFn<C, K>
- Function: defineRegistry()
- Interface: DefineRegistryOptions<C>
- Interface: DefineRegistryResult
- Function: getActorContext()
- Function: getPlayViewContext()
- Type Alias: JSONUIProviderProps
- Type Alias: OnRenderError
- @xmachines/play-svelte
- Type Alias: PlayRenderer
- Variable: PlayRenderer
- Interface: PlayUIProviderProps
- Type Alias: RenderErrorHandler
- Interface: RenderErrorInfo
- Type Alias: RenderErrorKind
- Variable: schema
- Function: setActorContext()
- Type Alias: SetState
- Interface: ViewContextValue
play-svelte-spa-router
- Interface: BasePathOptions
- Function: connectRouter()
- Interface: ConnectRouterOptions
- @xmachines/play-svelte-spa-router
- Interface: PlayRouteEvent
- Interface: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Interface: RouterConnection()
- Class: SvelteSpaRouterBridge
- Interface: WindowLike
play-sveltekit-router
- Interface: BasePathOptions
- Function: connectRouter()
- Interface: ConnectRouterOptions
- Interface: LocationLike
- @xmachines/play-sveltekit-router
- Interface: PlayRouteEvent
- Interface: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Interface: RouterConnection()
- Type Alias: ShallowNavigation
- Class: SvelteKitRouterBridge
- Interface: SvelteKitRouterBridgeOptions
play-tanstack-react-router
- Function: createPlayRouterProvider()
- Function: createRouteMapFromTree()
- @xmachines/play-tanstack-react-router
- Interface: PlayRouteEvent
- Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
- Variable: PlayRouterProvider
- Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
- Interface: PlayRouterProviderProps<TActor>
- Interface: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Class: TanStackReactRouterBridge
- Type Alias: TanStackRouterInstance
- Type Alias: TanStackRouterLike
play-tanstack-router
play-tanstack-solid-router
- Function: createPlayRouterProvider()
- @xmachines/play-tanstack-solid-router
- Interface: PlayRouteEvent
- Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
- Variable: PlayRouterProvider
- Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
- Interface: PlayRouterProviderProps<TActor>
- Interface: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Type Alias: TanStackRouterInstance
- Type Alias: TanStackRouterLike
- Class: TanStackSolidRouterBridge
play-url
- errors
- index
- Interface: BasePathOptions
- Function: buildPath()
- Function: cleanFrameworkParams()
- Interface: CompileOptions
- Function: createLruCache()
- Interface: FrameworkParamsSource
- Function: getCandidates()
- Function: getCompiledPattern()
- Function: getIndexKey()
- Interface: GroupPart
- Function: holdsUnsubstitutedParam()
- Class: InvalidBasePathError
- Class: InvalidRoutePatternError
- Function: isDotSegment()
- Function: joinBasePath()
- Interface: KeyValueCache<V>
- Interface: LiteralPart
- Class: MissingBasePathParamError
- Variable: NO_BASE_PATH
- Function: normalizeBasePath()
- Interface: ParamPart
- Interface: ParsedPattern
- Interface: ParseOptions
- Function: parsePattern()
- Type Alias: PathBuildResult
- Type Alias: PathParams
- Type Alias: PatternModifier
- Interface: PatternParam
- Type Alias: PatternPart
- Function: pickOwnParams()
- @xmachines/play-url
- Function: resolveBasePath()
- Interface: ResolvedBasePath
- Function: resolveFrameworkParams()
- Function: sanitizePathname()
- Function: splitLocation()
- Interface: SplitLocation
- Function: stripBasePath()
- Variable: URLPattern
- Type Alias: URLPatternCtor
- Type Alias: URLPatternLike
play-view
- errors
- index
- Function: attachRenderErrorHandler()
- Interface: BaseActorProviderProps<TRegistry, TActor>
- Interface: BaseViewContextValue<TRegistry>
- Function: bindStoreHandlers()
- Interface: ComposedView
- Function: composePlayState()
- Function: composeViews()
- Variable: CONTEXT_STATE_KEY
- Function: createActorProxy()
- Function: createRenderErrorBinding()
- Function: createReportGuard()
- Function: createViewSession()
- Function: createViewStoreLifecycle()
- Function: forwardRenderError()
- Function: guardContextWrites()
- Interface: HandlerFactory<THandlers>
- Class: InvalidViewOutletError
- @xmachines/play-view
- Interface: PlaySpec
- Class: ReadOnlyContextError
- Function: refreshContextSubtree()
- Interface: ReportGuard
- Interface: ReportGuardMessages
- Interface: ResolveViewStoreOptions
- Function: reuseComposedState()
- Type Alias: StateUpdater
- Function: toAtomState()
- Function: typedSpec()
- Interface: Viewable
- Type Alias: ViewActor<TSnapshot, TEvent>
- Class: ViewElementKeyCollisionError
- Interface: ViewMeta
- Interface: ViewOutlet
- Interface: ViewSession<TActor>
- Interface: ViewSessionOptions
- Interface: ViewSessionSnapshot<TActor>
- Interface: ViewStoreLifecycle
- Interface: ViewStoreResolution
- Interface: ViewTree
- Interface: ViewTreeChild
play-vue
- Variable: ActionProvider
- Interface: ActionProviderProps
- Interface: ActorProviderProps
- Type Alias: AnyPlayActor
- Interface: ComponentContext<C, K>
- Type Alias: ComponentEntry<C, K>
- Type Alias: ComponentFn<C, K>
- Type Alias: ComponentsMap<C>
- Function: defineRegistry()
- Type Alias: DefineRegistryOptions<C>
- Interface: DefineRegistryResult
- Variable: JSONUIProvider
- Interface: JSONUIProviderProps
- Type Alias: OnRenderError
- @xmachines/play-vue
- Variable: PlayRenderer
- Interface: PlayUIProviderProps
- Variable: Renderer
- Interface: RendererProps
- Type Alias: RenderErrorHandler
- Interface: RenderErrorInfo
- Type Alias: RenderErrorKind
- Variable: schema
- Variable: StateProvider
- Interface: StateProviderProps
- Function: useActor()
- Function: useBoundProp()
- Function: useFieldValidation()
- Function: usePlayView()
- Variable: ValidationProvider
- Interface: ValidationProviderProps
- Interface: ViewContextValue
- Variable: VisibilityProvider
play-vue-router
play-xstate
- errors
- index
- with-routing
- with-view
- Class: ActorThrewNonErrorError
- Function: buildRouteUrl()
- Type Alias: Capability<TMachine, TAdded>
- Function: compose()
- Function: definePlayer()
- Function: deriveRoute()
- Function: formatPlayRouteTransitions()
- Class: InvalidEventError
- Class: InvalidMachineError
- Class: InvalidRouteHandlerError
- Class: InvalidRouteMetadataError
- Class: InvalidRouteParamError
- Function: isAbsoluteRoute()
- Class: MissingRouteParamError
- Class: MissingStateIdError
- @xmachines/play-xstate
- Class: PlayerActor<TMachine>
- Interface: PlayerConfig<TMachine, TCapabilities>
- Type Alias: PlayerConstructor<TMachine, TCapabilities>
- Type Alias: PlayerFactory<TMachine, TCapabilities>
- Interface: PlayerFactoryResumeOptions<TMachine>
- Interface: PlayerOptions<TMachine>
- Interface: RouteContext
- Type Alias: RouteData
- Type Alias: RouteDataResolver
- Type Alias: RouteMachineConfig
- Type Alias: RouteMetadata
- Interface: RouteObject
- Type Alias: RouteStateNode
- Function: withRouting()
- Function: withView()
shared
- vite-aliases
- vitest
- Function: defineXmBrowserConfig()
- Function: defineXmVitestConfig()
- @xmachines/shared
- Function: xmAliases()
- Interface: XmBrowserConfigOptions
- Function: xmBuildOutput()
- Function: xmBuildOutputFile()
- Function: xmCacheDir()
- Function: xmOptimizeDeps()
- Function: xmResolve()
- Function: xmSvelteRunes()
- Function: xmTestTarget()
- Type Alias: XmTestTarget