From 98d820030c97cf35eda8afe5382b8932133f5b3a Mon Sep 17 00:00:00 2001 From: Adam Date: Tue, 26 May 2020 12:49:50 -0500 Subject: [PATCH] docs(platform-server): fix renderModule usage guidance with Ivy (#37296) Before the introduction of the Ivy renderer, users would compile their applications and use the resulting factories for SSR, since these post-compilation artifacts ensured faster delivery. Thus, using the original module as the rendering entrypoint was considered suboptimal and was discouraged. However, with the introduction of Ivy, this guidance is no longer applicable since these factories are no longer generated. Comparable speed is achieved using the factory-less module renderer, and so we update the guiance in the docs for the method. PR Close #37296 --- packages/platform-server/src/utils.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/platform-server/src/utils.ts b/packages/platform-server/src/utils.ts index 99c36dad8c..ff8674f20b 100644 --- a/packages/platform-server/src/utils.ts +++ b/packages/platform-server/src/utils.ts @@ -93,8 +93,10 @@ the server-rendered app can be properly bootstrapped into a client app.`); * `url` is the URL for the current render request. * `extraProviders` are the platform level providers for the current render request. * - * Do not use this in a production server environment. Use pre-compiled {@link NgModuleFactory} with - * {@link renderModuleFactory} instead. + * If compiling with the ViewEngine renderer, do not use this in a production server environment. + * Use pre-compiled {@link NgModuleFactory} with {@link renderModuleFactory} instead. If + * compiling with the Ivy renderer, this method is the recommended rendering method for + * platform-server. * * @publicApi */