NodeServicesOptions Class

Definition

Namespace:

Microsoft.AspNetCore.NodeServices

Assembly:

Microsoft.AspNetCore.NodeServices.dll

Package:

Microsoft.AspNetCore.NodeServices v3.1.18

Source:

NodeServicesOptions.cs

Caution

Use Microsoft.AspNetCore.SpaServices.Extensions

Describes options used to configure an INodeServices instance.

public ref class NodeServicesOptions

[System.Obsolete("Use Microsoft.AspNetCore.SpaServices.Extensions")]
public class NodeServicesOptions

[<System.Obsolete("Use Microsoft.AspNetCore.SpaServices.Extensions")>]
type NodeServicesOptions = class

Public Class NodeServicesOptions

Inheritance

Object

NodeServicesOptions

Attributes

ObsoleteAttribute

Constructors

NodeServicesOptions(IServiceProvider)

Creates a new instance of NodeServicesOptions.

Properties

ApplicationStoppingToken	A token that indicates when the host application is stopping.
DebuggingPort	If LaunchWithDebugging is true, the Node.js instance will listen for V8 debugger connections on this port.
EnvironmentVariables	If set, starts the Node.js instance with the specified environment variables.
InvocationTimeoutMilliseconds	Specifies the maximum duration, in milliseconds, that your .NET code should wait for Node.js RPC calls to return.
LaunchWithDebugging	If true, the Node.js instance will accept incoming V8 debugger connections (e.g., from node-inspector).
NodeInstanceFactory	Specifies how to construct Node.js instances. An INodeInstance encapsulates all details about how Node.js instances are launched and communicated with. A new INodeInstance will be created automatically if the previous instance has terminated (e.g., because a source file changed).
NodeInstanceOutputLogger	The Node.js instance's stdout/stderr will be redirected to this ILogger.
ProjectPath	If set, overrides the path to the root of your application. This path is used when locating Node.js modules relative to your project.
WatchFileExtensions	If set, the Node.js instance should restart when any matching file on disk within your project changes.

Extension Methods

UseHttpHosting(NodeServicesOptions)

Obsolete. Configures the INodeServices service so that it will use out-of-process Node.js instances and perform RPC calls over HTTP.