@@ -10,6 +10,8 @@ import { EnvironmentProviders, InjectionToken, makeEnvironmentProviders } from '
10
10
11
11
/**
12
12
* Different rendering modes for server routes.
13
+ * @see {@link provideServerRoutesConfig }
14
+ * @see {@link ServerRoute }
13
15
* @developerPreview
14
16
*/
15
17
export enum RenderMode {
@@ -29,7 +31,7 @@ export enum RenderMode {
29
31
/**
30
32
* Defines the fallback strategies for Static Site Generation (SSG) routes when a pre-rendered path is not available.
31
33
* 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 }
33
35
* @developerPreview
34
36
*/
35
37
export enum PrerenderFallback {
@@ -68,6 +70,7 @@ export interface ServerRouteCommon {
68
70
69
71
/**
70
72
* A server route that uses AppShell rendering mode.
73
+ * @see {@link RenderMode }
71
74
*/
72
75
export interface ServerRouteAppShell extends Omit < ServerRouteCommon , 'headers' | 'status' > {
73
76
/** Specifies that the route uses AppShell rendering mode. */
@@ -76,6 +79,7 @@ export interface ServerRouteAppShell extends Omit<ServerRouteCommon, 'headers' |
76
79
77
80
/**
78
81
* A server route that uses Client-Side Rendering (CSR) mode.
82
+ * @see {@link RenderMode }
79
83
*/
80
84
export interface ServerRouteClient extends ServerRouteCommon {
81
85
/** Specifies that the route uses Client-Side Rendering (CSR) mode. */
@@ -84,6 +88,7 @@ export interface ServerRouteClient extends ServerRouteCommon {
84
88
85
89
/**
86
90
* A server route that uses Static Site Generation (SSG) mode.
91
+ * @see {@link RenderMode }
87
92
*/
88
93
export interface ServerRoutePrerender extends Omit < ServerRouteCommon , 'status' > {
89
94
/** Specifies that the route uses Static Site Generation (SSG) mode. */
@@ -95,6 +100,8 @@ export interface ServerRoutePrerender extends Omit<ServerRouteCommon, 'status'>
95
100
96
101
/**
97
102
* 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 }
98
105
*/
99
106
export interface ServerRoutePrerenderWithParams extends Omit < ServerRoutePrerender , 'fallback' > {
100
107
/**
@@ -105,7 +112,7 @@ export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerende
105
112
* - `PrerenderFallback.Server`: Use Server-Side Rendering (SSR) to dynamically generate the page at request time.
106
113
* - `PrerenderFallback.Client`: Use Client-Side Rendering (CSR) to fetch and render the page on the client side.
107
114
* - `PrerenderFallback.None`: No fallback; if the path is not pre-rendered, the server will not handle the request.
108
- *
115
+ * @see { @link PrerenderFallback }
109
116
* @default `PrerenderFallback.Server` if not provided.
110
117
*/
111
118
fallback ?: PrerenderFallback ;
@@ -138,6 +145,7 @@ export interface ServerRoutePrerenderWithParams extends Omit<ServerRoutePrerende
138
145
139
146
/**
140
147
* A server route that uses Server-Side Rendering (SSR) mode.
148
+ * @see {@link RenderMode }
141
149
*/
142
150
export interface ServerRouteServer extends ServerRouteCommon {
143
151
/** Specifies that the route uses Server-Side Rendering (SSR) mode. */
@@ -146,6 +154,7 @@ export interface ServerRouteServer extends ServerRouteCommon {
146
154
147
155
/**
148
156
* Server route configuration.
157
+ * @see {@link provideServerRoutesConfig }
149
158
* @developerPreview
150
159
*/
151
160
export type ServerRoute =
@@ -166,6 +175,7 @@ export const SERVER_ROUTES_CONFIG = new InjectionToken<ServerRoute[]>('SERVER_RO
166
175
*
167
176
* @param routes - An array of server routes to be provided.
168
177
* @returns An `EnvironmentProviders` object that contains the server routes configuration.
178
+ * @see {@link ServerRoute }
169
179
* @developerPreview
170
180
*/
171
181
export function provideServerRoutesConfig ( routes : ServerRoute [ ] ) : EnvironmentProviders {
0 commit comments