Module / v1.0.0-beta.13

@typed/vue

39 unique exports available through this public import path, including their members and aliases.

import * as vue from "@typed/vue";

class

  • VueError

    class · Re-export

    A Vue mount, update, configuration, or server-rendering failure.

function

  • createTypedComponent

    function · Re-export

    Creates a Vue component bound to a borrowed runtime. Vue owns the native Typed renderer and its replacement Scope. The caller owns runtime disposal.

  • fromContext

    function

    Adapt an Effect context without allocating or taking ownership of a runtime.

  • installRuntime

    function

    Install once per Vue app or SSR request. Reactive replacements flow to descendants.

  • prefetch

    function

    A request-local first snapshot for seeding SSR and client hydration with identical data.

  • provideCurrentRoute

    function

    Public function exposed as provideCurrentRoute from @typed/vue.

  • provideRuntime

    function

    Override execution for this component and its descendants during setup.

  • provideServices

    function

    Provide reactive service overrides to this component and its descendants.

  • routeComponent

    function

    Adapt a Vue component to a Typed route handler. Render the full matcher with Typed’s renderer (or the inverse Typed component), keeping route resources alive through SSR.

  • useAsyncData

    function

    Derive display state without starting another Effect subscription.

  • useAsyncDataSource

    function

    Observe a Typed AsyncData source directly, preserving its loading and optimistic states.

  • useCurrentPath

    function

    Public function exposed as useCurrentPath from @typed/vue.

  • useCurrentRoute

    function

    Stable structural route mount, distinct from live location.

  • useEffect

    function

    Public function exposed as useEffect from @typed/vue.

  • useFx

    function

    Public function exposed as useFx from @typed/vue.

  • useLocation

    function

    Public function exposed as useLocation from @typed/vue.

  • useMatcher

    function

    Run the actual Typed matcher with Vue scope ownership and typed routing failures.

  • useNavigation

    function

    Live navigation uses the provider’s backend, including BrowserRouter/ServerRouter/TestRouter.

  • useRefSubject

    function

    Observe a RefSubject and write through its Effect update path in the Vue scope.

  • useRoute

    function

    Decode under the inherited mount, or a reactive explicit root applied exactly once.

  • useRuntime

    function

    Read a provider, or use ordinary Effect execution for service-free components.

  • useService

    function

    Public function exposed as useService from @typed/vue.

  • useStream

    function

    Public function exposed as useStream from @typed/vue.

  • view

    function · Re-export

    Embed Vue in Typed, retaining the props producer’s failure and service channels.

  • withServices

    function

    Shadow selected services, preserving all other services and the runtime’s ownership.

interface

  • AsyncDataView

    interface

    Vue projections of AsyncData. The latest available value survives refreshes and later failures.

  • AsyncState

    interface

    Public interface exposed as AsyncState from @typed/vue.

  • ReactiveOptions

    interface

    Skip automatic execution (including SSR); refresh explicitly when ready.

  • RefSubjectState

    interface

    Public interface exposed as RefSubjectState from @typed/vue.

  • RouteOptions

    interface

    Options for decoding a route relative to an explicit or inherited structural mount.

  • ViewOptions

    interface · Re-export

    Configuration is applied to a new app before mount, hydration, or server rendering.

type-alias

  • ComponentProps

    type-alias · Re-export

    Public props accepted by a Vue SFC, defineComponent, or functional component.

  • PropsSource

    type-alias · Re-export

    A whole props snapshot, optionally produced reactively. Functions in props remain functions.

  • ReactiveSource

    type-alias

    Public type-alias exposed as ReactiveSource from @typed/vue.

  • RouteComponentProps

    type-alias

    Declared route props exclude optional Vue infrastructure props such as ref and key.

  • RuntimeRef

    type-alias

    Public type-alias exposed as RuntimeRef from @typed/vue.

  • VueRuntime

    type-alias

    Execution borrowed from an application/request owner; Vue never disposes its runtime.

variable

  • RuntimeKey

    variable

    Vue injection erases service types; explicit runtime options retain them at call sites.

  • Typed

    variable · Re-export

    Typed view using the inherited runtime when present.