ISpaPrerenderer.RenderToString(String, String, Object, Int32) Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.SpaServices.Prerendering

Assembly:: Microsoft.AspNetCore.SpaServices.dll

Package:: Microsoft.AspNetCore.SpaServices v2.0.0

Package:: Microsoft.AspNetCore.SpaServices v2.1.0

Package:: Microsoft.AspNetCore.SpaServices v2.2.0

Package:: Microsoft.AspNetCore.SpaServices v3.0.3

Package:: Microsoft.AspNetCore.SpaServices v3.1.18

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Invokes JavaScript code to perform server-side prerendering for a Single-Page Application. This is an alternative to using the 'asp-prerender-module' tag helper.

public System.Threading.Tasks.Task<Microsoft.AspNetCore.SpaServices.Prerendering.RenderToStringResult> RenderToString (string moduleName, string exportName = default, object customDataParameter = default, int timeoutMilliseconds = 0);

abstract member RenderToString : string * string * obj * int -> System.Threading.Tasks.Task<Microsoft.AspNetCore.SpaServices.Prerendering.RenderToStringResult>

Public Function RenderToString (moduleName As String, Optional exportName As String = Nothing, Optional customDataParameter As Object = Nothing, Optional timeoutMilliseconds As Integer = 0) As Task(Of RenderToStringResult)

Parameters

moduleName: String

The JavaScript module that exports a prerendering function.

exportName: String

The name of the export from the JavaScript module, if it is not the default export.

customDataParameter: Object

An optional JSON-serializable object to pass to the JavaScript prerendering function.

timeoutMilliseconds: Int32

If specified, the prerendering task will time out after this duration if not already completed.

Returns

Task<RenderToStringResult>

Applies to