@@ -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,9 @@ 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 }
105+ * @see {@link PrerenderFallback }
98106 */
99107export interface ServerRoutePrerenderWithParams extends Omit < ServerRoutePrerender , 'fallback' > {
100108 /**
@@ -138,6 +146,7 @@ export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerende
138146
139147/**
140148 * A server route that uses Server-Side Rendering (SSR) mode.
149+ * @see {@link RenderMode }
141150 */
142151export interface ServerRouteServer extends ServerRouteCommon {
143152 /** Specifies that the route uses Server-Side Rendering (SSR) mode. */
@@ -146,6 +155,7 @@ export interface ServerRouteServer extends ServerRouteCommon {
146155
147156/**
148157 * Server route configuration.
158+ * @see {@link provideServerRoutesConfig }
149159 * @developerPreview
150160 */
151161export type ServerRoute =
@@ -166,6 +176,7 @@ export const SERVER_ROUTES_CONFIG = new InjectionToken<ServerRoute[]>('SERVER_RO
166176 *
167177 * @param routes - An array of server routes to be provided.
168178 * @returns An `EnvironmentProviders` object that contains the server routes configuration.
179+ * @see {@link ServerRoute }
169180 * @developerPreview
170181 */
171182export function provideServerRoutesConfig ( routes : ServerRoute [ ] ) : EnvironmentProviders {
0 commit comments