Builds the canonical full-stack plugin set. Composes from buildMicroservicePlugins
and appends the full-stack plugins (cache, events, cqrs, scheduler, audit, secrets, storage, mail).
The list is exported for advanced custom composition.
Creates a fully wired full-stack application. The factory registers the curated full-stack plugin set (microservice + cache, events, cqrs, scheduler, audit, secrets, storage, mail), adds the error-handler middleware at priority 0 (outermost per exceptions contract), and returns the un-started application.
Creates a full-stack application whose options are derived from configuration.
Options for createFullStackAppFromConfig.
-
config: ConfigPluginOptions
Loading options —
.envpaths, variable expansion, validation schema. -
env: Readonly<Record<string, unknown>> | undefined
The environment to read configuration from, instead of the platform's.
Options for createFullStackApp. Extends MicroserviceStarterOptions
with full-stack arms (always-on + gated). Omitted plugins use their defaults.
-
audit: AuditPluginOptions
Always-on arm:
AuditPlugin. Omitted → memory storage default. -
cache: CachePluginOptions
Always-on arm:
CachePlugin. Omitted → memory store default. -
cqrs: CqrsPluginOptions
Always-on arm:
CqrsPlugin. Omitted → no built-in behaviors. -
events: EventsPluginOptions
Always-on arm:
EventsPlugin. Omitted → in-memory bus default. -
featureFlags: FeatureFlagsPluginOptions
Optional arm:
FeatureFlagsPlugin. Gated — requires a provider to be useful. -
mail: MailPluginOptions
Always-on arm:
MailPlugin. Omitted → log provider default. -
multiTenancy: MultiTenancyPluginOptions
Optional arm:
MultiTenancyPlugin. Gated — requires resolvers to be useful. -
notifications: NotificationPluginOptions
Optional arm:
NotificationPlugin. Gated — requires channels to be useful. -
reactRouter: ReactRouterPluginOptions
Optional arm:
ReactRouterPlugin. Gated — requiresserverBuildPathfor SSR. -
scheduler: SchedulerPluginOptions
Always-on arm:
SchedulerPlugin. Omitted → defaults. -
secrets: SecretsPluginOptions
Always-on arm:
SecretsPlugin. Omitted → env provider default. -
static: StaticPluginOptions
Optional arm:
StaticPlugin. Gated — requiresrootto serve from; absent registers nothing, leaving the composition byte-identical. -
storage: StoragePluginOptions
Always-on arm:
StoragePlugin. Omitted → memory provider default.
The real-time arm: one option grouping the three plugins that together make a connection-oriented application work, each added only when its sub-arm is present.
-
backplane: RealtimeBackplanePluginOptions
Options for
RealtimeBackplanePlugin, which fans WebSocket rooms and SSE channels out across replicas. Present → the plugin is registered atPLUGIN_PRIORITY.HIGH, so it precedes both consumers. -
sse: SsePluginOptions
Options for
SsePlugin. Present → the plugin is registered. -
websocket: WebSocketPluginOptions
Options for
WebSocketPlugin. Present → the plugin is registered.
Options for configuring the StaticPlugin.
-
cacheControl: string | ((relativePath: string) => string)
Cache-Control header configuration (default: function returning immutable for hashed assets, must-revalidate for others).
-
compressed: boolean
Enable precompressed sidecar negotiation (default: true).
-
etag: boolean
Enable ETag generation (default: true).
-
fallback: string
Fallback file to serve for missing paths when Accept includes text/html (default: undefined). Used for SPA fallback.
-
fs: IFileSystem
The filesystem to use for file operations.
-
index: string
Index file to serve when a directory is requested (default: 'index.html'). Set to empty string '' to disable index resolution.
-
maxBufferBytes: number
Maximum file size to read fully into memory (default: 1MB). Files larger than this will use streaming when available.
-
ranges: boolean
Enable Range request handling (default: true).
-
root: string
Required. The filesystem directory to serve files from.
-
urlPrefix: string
URL prefix for static routes (default: '/').
Usage
import * as Full_stack_starter_bundle___every_capability_plugin_with_sensible_defaults___Provides_a_single_factory___linkcode_createFullStackApp__that_returns_a_fully_wired___linkcode_IKernelApplication__with_the_curated_full_stack_plugin_set_and_error_handling_middleware__Also_exposes_the_option_type___linkcode_FullStackStarterOptions__and_the_plugin_builder___linkcode_buildFullStackPlugins__for_advanced_composition__ from "starters/full-stack-starter/src/index.ts";