mirror of
https://github.com/aspnet/JavaScriptServices.git
synced 2025-12-24 02:30:13 +00:00
Add XML docs to core packages
This commit is contained in:
@@ -2,13 +2,42 @@ using System.Collections.Generic;
|
||||
|
||||
namespace Microsoft.AspNetCore.SpaServices.Webpack
|
||||
{
|
||||
/// <summary>
|
||||
/// Options for configuring a Webpack dev middleware compiler.
|
||||
/// </summary>
|
||||
public class WebpackDevMiddlewareOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// If true, hot module replacement (HMR) will be enabled. This automatically updates Webpack-built
|
||||
/// resources (such as JavaScript, CSS, or images) in your web browser whenever source files are changed.
|
||||
/// </summary>
|
||||
public bool HotModuleReplacement { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Overrides the internal port number that client-side HMR code will connect to.
|
||||
/// </summary>
|
||||
public int HotModuleReplacementServerPort { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// If true, enables React-specific extensions to Webpack's hot module replacement (HMR) feature.
|
||||
/// This enables React components to be updated without losing their in-memory state.
|
||||
/// </summary>
|
||||
public bool ReactHotModuleReplacement { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Specifies the Webpack configuration file to be used. If not set, defaults to 'webpack.config.js'.
|
||||
/// </summary>
|
||||
public string ConfigFile { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The root path of your project. Webpack runs in this context.
|
||||
/// </summary>
|
||||
public string ProjectPath { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Specifies additional environment variables to be passed to the Node instance hosting
|
||||
/// the webpack compiler.
|
||||
/// </summary>
|
||||
public IDictionary<string, string> EnvironmentVariables { get; set; }
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user