@octanejs/tanstack-start
v0.1.27
Published
TanStack Start for Octane, including file-route generation, server functions, SSR streaming, hydration, and Vite integration.
Readme
@octanejs/tanstack-start
TanStack Start for Octane. This package owns the renderer integration needed for file-route generation, route code splitting, server functions, streaming SSR, hydration, and Vite development and production builds.
It uses @octanejs/tanstack-router for the public router
binding and published renderer-neutral TanStack core packages for shared Start
and Router behavior. The Octane-specific generator, compiler, and Vite adapter
live inside this package, so installing it does not require private workspace
packages or preview release artifacts.
Vite setup
import { defineConfig } from 'vite';
import { tanstackStart } from '@octanejs/tanstack-start/plugin/vite';
export default defineConfig({
plugins: [tanstackStart()],
});The plugin installs Octane compilation before route analysis, generates TSRX
file routes with imports from @octanejs/tanstack-router, compiles Start's
environment-specific APIs, and configures the client and SSR Vite environments.
Application code imports Start APIs from this package and router APIs from the Octane router binding:
import { createServerFn } from '@octanejs/tanstack-start';
import { createFileRoute } from '@octanejs/tanstack-router';Public entries
@octanejs/tanstack-start@octanejs/tanstack-start/client@octanejs/tanstack-start/server@octanejs/tanstack-start/plugin/vite- RPC and environment-marker entries used by the Start compiler
@octanejs/tanstack-start/server-entry
The compiler and generator internals are implementation details and are not public package exports.
Upstream basis
The renderer adapter is derived from TanStack Router pull request #7847 at
snapshot 753f919e, with repository-owned fixes for TSRX typing and Octane's
native streamed HTML injection. See THIRD_PARTY_NOTICES.md for attribution.
