provideClientHydration
Sets up providers necessary to enable hydration functionality for the application.
API
function provideClientHydration(
...features: HydrationFeature<HydrationFeatureKind>[]
): EnvironmentProviders;provideClientHydration
Sets up providers necessary to enable hydration functionality for the application.
By default, the function enables the recommended set of features for the optimal performance for most of the applications. It includes the following features:
- Reconciling DOM hydration. Learn more about it here.
HttpClientresponse caching while running on the server and transferring this cache to the client to avoid extra HTTP requests. Learn more about data caching here.
These functions allow you to disable some of the default features or enable new ones:
withNoHttpTransferCacheto disable HTTP transfer cachewithHttpTransferCacheOptionsto configure some HTTP transfer cache optionswithI18nSupportto enable hydration support for i18n blockswithEventReplayto enable support for replaying user events
HydrationFeature<HydrationFeatureKind>[]Optional features to configure additional hydration behaviors.
EnvironmentProvidersDescription
Sets up providers necessary to enable hydration functionality for the application.
By default, the function enables the recommended set of features for the optimal performance for most of the applications. It includes the following features:
- Reconciling DOM hydration. Learn more about it here.
HttpClientresponse caching while running on the server and transferring this cache to the client to avoid extra HTTP requests. Learn more about data caching here.
These functions allow you to disable some of the default features or enable new ones:
withNoHttpTransferCacheto disable HTTP transfer cachewithHttpTransferCacheOptionsto configure some HTTP transfer cache optionswithI18nSupportto enable hydration support for i18n blockswithEventReplayto enable support for replaying user events
Usage Notes
Basic example of how you can enable hydration in your application when
bootstrapApplication function is used:
bootstrapApplication(AppComponent, { providers: [provideClientHydration()]});
Alternatively if you are using NgModules, you would add provideClientHydration
to your root app module's provider list.
@NgModule({ declarations: [RootCmp], bootstrap: [RootCmp], providers: [provideClientHydration()],})export class AppModule {}