Framework Bindings & Meta-Frameworks¶

Framework-idiomatic reactive stream bindings (litestar-vite-plugin/react, /vue, /svelte) and meta-framework Vite/Nitro integrations (litestar-vite-plugin/astro, /sveltekit, /nuxt).

litestar-vite-plugin/react¶

Package Subpath: ./react · Types: ./dist/js/react/index.d.ts · Source: src/js/src/react/index.ts

React bindings for generic and Litestar Queues event streams.

EventStreamState¶

export interface EventStreamState<TFrame>

ReactEventStreamOptions¶

export type ReactEventStreamOptions<TFrame> = EventStreamOptions<TFrame> & {

ReactQueueEventStreamOptions¶

export type ReactQueueEventStreamOptions<TFrame> = QueueEventStreamOptions<TFrame> & {

AdapterOptions¶

export type AdapterOptions<TFrame> = ReactEventStreamOptions<TFrame> | ReactQueueEventStreamOptions<TFrame>

StreamFactory¶

export type StreamFactory = (options: never) => EventStream

useEventStream¶

export function useEventStream<TFrame = unknown>(options: ReactEventStreamOptions<TFrame>): EventStreamState<TFrame>

Subscribe a React component to a generic event stream.

useQueueEventStream¶

export function useQueueEventStream<TFrame = unknown>(options: ReactQueueEventStreamOptions<TFrame>): EventStreamState<TFrame>

Subscribe a React component to a Litestar Queues event stream.

litestar-vite-plugin/vue¶

Package Subpath: ./vue · Types: ./dist/js/vue/index.d.ts · Source: src/js/src/vue/index.ts

Vue bindings for generic and Litestar Queues event streams.

VueEventStreamState¶

export interface VueEventStreamState<TFrame>

VueEventStreamOptions¶

export type VueEventStreamOptions<TFrame> = EventStreamOptions<TFrame> & {

VueQueueEventStreamOptions¶

export type VueQueueEventStreamOptions<TFrame> = QueueEventStreamOptions<TFrame> & {

AdapterOptions¶

export type AdapterOptions<TFrame> = VueEventStreamOptions<TFrame> | VueQueueEventStreamOptions<TFrame>

StreamFactory¶

export type StreamFactory = (options: never) => EventStream

useEventStream¶

export function useEventStream<TFrame = unknown>(options: VueEventStreamOptions<TFrame>): VueEventStreamState<TFrame>

Subscribe a Vue scope to a generic event stream.

useQueueEventStream¶

export function useQueueEventStream<TFrame = unknown>(options: VueQueueEventStreamOptions<TFrame>): VueEventStreamState<TFrame>

Subscribe a Vue scope to a Litestar Queues event stream.

litestar-vite-plugin/svelte¶

Package Subpath: ./svelte · Types: ./dist/js/svelte/index.d.ts · Source: src/js/src/svelte/index.ts

Svelte stores for generic and Litestar Queues event streams.

EventStreamStoreState¶

export interface EventStreamStoreState<TFrame>

SvelteEventStreamOptions¶

export type SvelteEventStreamOptions<TFrame> = EventStreamOptions<TFrame> & { bufferSize?: number }

SvelteQueueEventStreamOptions¶

export type SvelteQueueEventStreamOptions<TFrame> = QueueEventStreamOptions<TFrame> & { bufferSize?: number }

AdapterOptions¶

export type AdapterOptions<TFrame> = SvelteEventStreamOptions<TFrame> | SvelteQueueEventStreamOptions<TFrame>

StreamFactory¶

export type StreamFactory = (options: never) => EventStream

createEventStreamStore¶

export function createEventStreamStore<TFrame = unknown>(options: SvelteEventStreamOptions<TFrame>): Readable<EventStreamStoreState<TFrame>>

Create a readable store backed by a generic event stream.

createQueueEventStreamStore¶

export function createQueueEventStreamStore<TFrame = unknown>(options: SvelteQueueEventStreamOptions<TFrame>): Readable<EventStreamStoreState<TFrame>>

Create a readable store backed by a Litestar Queues event stream.

litestar-vite-plugin/astro¶

Package Subpath: ./astro · Types: ./dist/js/astro.d.ts · Source: src/js/src/astro.ts

Astro 5 integration for Litestar-Vite.

AstroConfigPartial¶

export interface AstroConfigPartial

Astro config for updateConfig - partial types we support.

AddressInfo¶

export interface AddressInfo

AddressInfo from Node.js net module.

AstroIntegration¶

export interface AstroIntegration

AstroIntegrationLogger¶

export interface AstroIntegrationLogger

Astro integration logger interface.

AstroTypesConfig¶

export type AstroTypesConfig = TypesConfigShape

Configuration for TypeScript type generation. Same fields as TypesConfig.

LitestarAstroConfig¶

export type LitestarAstroConfig = LitestarIntegrationConfig

Configuration options for the Litestar integration.

litestarAstro¶

export default function litestarAstro(userConfig: LitestarAstroConfig = {}): AstroIntegration

Litestar integration for Astro.

litestar-vite-plugin/sveltekit¶

Package Subpath: ./sveltekit · Types: ./dist/js/sveltekit.d.ts · Source: src/js/src/sveltekit.ts

SvelteKit integration for Litestar-Vite.

SvelteKitTypesConfig¶

export type SvelteKitTypesConfig = TypesConfigShape

Configuration for TypeScript type generation. Same fields as TypesConfig.

LitestarSvelteKitConfig¶

export type LitestarSvelteKitConfig = LitestarIntegrationConfig

Configuration options for the Litestar integration.

litestarSvelteKit¶

export function litestarSvelteKit(userConfig: LitestarSvelteKitConfig = {}): any[]

Litestar integration plugin for SvelteKit.

litestar-vite-plugin/nuxt¶

Package Subpath: ./nuxt · Types: ./dist/js/nuxt.d.ts · Source: src/js/src/nuxt.ts

Nuxt 4 module for Litestar-Vite.

NuxtModuleFunction¶

export interface NuxtModuleFunction

Nuxt module definition for Litestar integration.

ListenInfo¶

export interface ListenInfo

NuxtContext¶

export interface NuxtContext

NuxtTypesConfig¶

export type NuxtTypesConfig = TypesConfigShape

Configuration for TypeScript type generation. Same fields as TypesConfig.

LitestarNuxtConfig¶

export type LitestarNuxtConfig = LitestarIntegrationConfig

Configuration options for the Litestar integration.

litestarModule¶

export const litestarModule: NuxtModuleFunction