JasprRenderMode enum

Rendering strategy for Jaspr web sites.

Determines jaspr.yaml mode, whether lib/main.server.dart is kept, whether the project ships a Dockerfile for a Cloud Run service, and what firebase.json rewrites look like after ConfigGenerator runs.

Inheritance
Available extensions

Values

csr → const JasprRenderMode

Client-only SPA. jaspr build emits build/jaspr/index.html plus a hydration bundle. No server runtime; hosted as static.

ssg → const JasprRenderMode

Static pre-render at build time. jaspr build runs every page once through main.server.dart to emit per-route HTML files, then ships them as static. SEO-friendly. No Cloud Run.

ssr → const JasprRenderMode

Server-rendered at request time. jaspr build emits a Dart entrypoint; Oracular wraps it in a Docker image and deploys to Cloud Run. Firebase Hosting fronts the service via rewrites.

hybrid → const JasprRenderMode

Mix of ssg and ssr — some routes are statically pre-rendered at build time, others are rendered at request time on Cloud Run. Firebase Hosting rewrites only the dynamic prefixes to Cloud Run.

embed → const JasprRenderMode

Jaspr static host with a Flutter web app embedded at SetupConfig.embeddedFlutterMount. Reserved for the arcaneJasprFlutterEmbed template; not applicable to other Jaspr templates.

Properties

description → String

Available on JasprRenderMode, provided by the JasprRenderModeExtension extension

One-line description shown in wizard menus and generated docs.
no setter
displayName → String

Available on JasprRenderMode, provided by the JasprRenderModeExtension extension

Short display label (e.g. CSR, SSG).
no setter
hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
jasprYamlMode → String

Available on JasprRenderMode, provided by the JasprRenderModeExtension extension

Value used in the jaspr.yaml mode: field.
no setter
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
needsServerEntrypoint → bool

Available on JasprRenderMode, provided by the JasprRenderModeExtension extension

True for modes that emit a main.server.dart entrypoint that runs at build time (SSG / Embed prerender) or at runtime (SSR / Hybrid).
no setter
requiresCloudRun → bool

Available on JasprRenderMode, provided by the JasprRenderModeExtension extension

True for modes that produce a Cloud Run service (Dart binary) in addition to whatever ends up on Firebase Hosting.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<JasprRenderMode>
A constant List of the values in this enum, in order of their declaration.