@@ -10,6 +10,8 @@ import { EnvironmentProviders, InjectionToken, makeEnvironmentProviders } from '
1010
1111/**
1212 * Different rendering modes for server routes.
13+ * @see {@link provideServerRoutesConfig }
14+ * @see {@link ServerRoute }
1315 * @developerPreview
1416 */
1517export enum RenderMode {
@@ -29,7 +31,7 @@ export enum RenderMode {
2931/**
3032 * Defines the fallback strategies for Static Site Generation (SSG) routes when a pre-rendered path is not available.
3133 * This is particularly relevant for routes with parameterized URLs where some paths might not be pre-rendered at build time.
32- *
34+ * @see { @link ServerRoutePrerenderWithParams }
3335 * @developerPreview
3436 */
3537export enum PrerenderFallback {
@@ -68,6 +70,7 @@ export interface ServerRouteCommon {
6870
6971/**
7072 * A server route that uses AppShell rendering mode.
73+ * @see {@link RenderMode }
7174 */
7275export interface ServerRouteAppShell extends Omit < ServerRouteCommon , 'headers' | 'status' > {
7376 /** Specifies that the route uses AppShell rendering mode. */
@@ -76,6 +79,7 @@ export interface ServerRouteAppShell extends Omit<ServerRouteCommon, 'headers' |
7679
7780/**
7881 * A server route that uses Client-Side Rendering (CSR) mode.
82+ * @see {@link RenderMode }
7983 */
8084export interface ServerRouteClient extends ServerRouteCommon {
8185 /** Specifies that the route uses Client-Side Rendering (CSR) mode. */
@@ -84,6 +88,7 @@ export interface ServerRouteClient extends ServerRouteCommon {
8488
8589/**
8690 * A server route that uses Static Site Generation (SSG) mode.
91+ * @see {@link RenderMode }
8792 */
8893export interface ServerRoutePrerender extends Omit < ServerRouteCommon , 'status' > {
8994 /** Specifies that the route uses Static Site Generation (SSG) mode. */
@@ -95,6 +100,8 @@ export interface ServerRoutePrerender extends Omit<ServerRouteCommon, 'status'>
95100
96101/**
97102 * A server route configuration that uses Static Site Generation (SSG) mode, including support for routes with parameters.
103+ * @see {@link RenderMode }
104+ * @see {@link ServerRoutePrerender }
98105 */
99106export interface ServerRoutePrerenderWithParams extends Omit < ServerRoutePrerender , 'fallback' > {
100107 /**
@@ -105,7 +112,7 @@ export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerende
105112 * - `PrerenderFallback.Server`: Use Server-Side Rendering (SSR) to dynamically generate the page at request time.
106113 * - `PrerenderFallback.Client`: Use Client-Side Rendering (CSR) to fetch and render the page on the client side.
107114 * - `PrerenderFallback.None`: No fallback; if the path is not pre-rendered, the server will not handle the request.
108- *
115+ * @see { @link PrerenderFallback }
109116 * @default `PrerenderFallback.Server` if not provided.
110117 */
111118 fallback ?: PrerenderFallback ;
@@ -138,6 +145,7 @@ export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerende
138145
139146/**
140147 * A server route that uses Server-Side Rendering (SSR) mode.
148+ * @see {@link RenderMode }
141149 */
142150export interface ServerRouteServer extends ServerRouteCommon {
143151 /** Specifies that the route uses Server-Side Rendering (SSR) mode. */
@@ -146,6 +154,7 @@ export interface ServerRouteServer extends ServerRouteCommon {
146154
147155/**
148156 * Server route configuration.
157+ * @see {@link provideServerRoutesConfig }
149158 * @developerPreview
150159 */
151160export type ServerRoute =
@@ -166,6 +175,7 @@ export const SERVER_ROUTES_CONFIG = new InjectionToken<ServerRoute[]>('SERVER_RO
166175 *
167176 * @param routes - An array of server routes to be provided.
168177 * @returns An `EnvironmentProviders` object that contains the server routes configuration.
178+ * @see {@link ServerRoute }
169179 * @developerPreview
170180 */
171181export function provideServerRoutesConfig ( routes : ServerRoute [ ] ) : EnvironmentProviders {
0 commit comments