JavaScriptHostingExtensions Methods

Docs/Reference/Search C# APIs/CommunityToolkit.Aspire.Hosting.JavaScript.Extensions/JavaScriptHostingExtensions/Methods

Methods

Docs Reference Search C# APIs CommunityToolkit.Aspire.Hosting.JavaScript.Extensions JavaScriptHostingExtensions Methods

ClassMethods15 members

Provides extension methods for adding JavaScript applications to the distributed application builder.

AddApp(IResourceBuilder<NxResource>, string, string?, Func<IResourceBuilder<NxAppResource>, IResourceBuilder<NxAppResource>>)extensionIResourceBuilder<NxAppResource>

Adds an individual app to an Nx workspace.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<NxAppResource> AddApp(
        this IResourceBuilder<NxResource> builder,
        string name,
        string? appName = null,
        Func<IResourceBuilder<NxAppResource>, IResourceBuilder<NxAppResource>>? configure = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs#L71-L109

Parameters

builderIResourceBuilder<NxResource>The Nx workspace resource builder.

namestringThe name of the app resource.

appNamestring?optionalThe Nx app name to run. If not specified, uses the name.

configureFunc<IResourceBuilder<NxAppResource>, IResourceBuilder<NxAppResource>>optionalA function to configure the app resource builder.

Returns

IResourceBuilder<NxAppResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.AddNxWorkspaceApp instead.

Ignored by ATS

Excluded from automatic Polyglot export.

AddApp(IResourceBuilder<TurborepoResource>, string, string?, Func<IResourceBuilder<TurborepoAppResource>, IResourceBuilder<TurborepoAppResource>>)extensionIResourceBuilder<TurborepoAppResource>

Adds an individual app to a Turborepo workspace.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TurborepoAppResource> AddApp(
        this IResourceBuilder<TurborepoResource> builder,
        string name,
        string? filter = null,
        Func<IResourceBuilder<TurborepoAppResource>, IResourceBuilder<TurborepoAppResource>>? configure = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs#L128-L166

Parameters

builderIResourceBuilder<TurborepoResource>The Turborepo workspace resource builder.

namestringThe name of the app resource.

filterstring?optionalThe Turborepo filter to use. If not specified, uses the name.

configureFunc<IResourceBuilder<TurborepoAppResource>, IResourceBuilder<TurborepoAppResource>>optionalA function to configure the app resource builder.

Returns

IResourceBuilder<TurborepoAppResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.AddTurborepoWorkspaceApp instead.

Ignored by ATS

Excluded from automatic Polyglot export.

AddNxApp(IDistributedApplicationBuilder, string, string?)extensionIResourceBuilder<NxResource>

Adds an Nx monorepo workspace to the distributed application builder.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<NxResource> AddNxApp(
        this IDistributedApplicationBuilder builder,
        string name,
        string? workingDirectory = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs#L25-L34

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder to add the resource to.

namestringThe name of the Nx workspace resource.

workingDirectorystring?optionalThe working directory of the Nx workspace. If not specified, it will be set to a path that is a sibling of the AppHost directory using the name as the folder.

Returns

IResourceBuilder<NxResource>A reference to the ApplicationModel.IResourceBuilder`1.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

AddTurborepoApp(IDistributedApplicationBuilder, string, string?)extensionIResourceBuilder<TurborepoResource>

Adds a Turborepo monorepo workspace to the distributed application builder.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TurborepoResource> AddTurborepoApp(
        this IDistributedApplicationBuilder builder,
        string name,
        string? workingDirectory = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs#L47-L56

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder to add the resource to.

namestringThe name of the Turborepo workspace resource.

workingDirectorystring?optionalThe working directory of the Turborepo workspace. If not specified, it will be set to a path that is a sibling of the AppHost directory using the name as the folder.

Returns

IResourceBuilder<TurborepoResource>A reference to the ApplicationModel.IResourceBuilder`1.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithBun(IResourceBuilder<NxResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<NxResource>

Configures the Nx workspace to use bun as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<NxResource> WithBun(
        this IResourceBuilder<NxResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<NxResource>The Nx workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<NxResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithNxBun instead.

Ignored by ATS

Excluded from automatic Polyglot export.

WithBun(IResourceBuilder<TurborepoResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<TurborepoResource>

Configures the Turborepo workspace to use bun as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TurborepoResource> WithBun(
        this IResourceBuilder<TurborepoResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<TurborepoResource>The Turborepo workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<TurborepoResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithTurborepoBun instead.

Ignored by ATS

Excluded from automatic Polyglot export.

WithMappedEndpointPort(IResourceBuilder<TResource>, string?)extensionIResourceBuilder<TResource>

Maps the endpoint port for the JavaScript.JavaScriptAppResource to the appropriate command line argument.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TResource> WithMappedEndpointPort<TResource>(
        this IResourceBuilder<TResource> builder,
        string? endpointName = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs#L259-L278

Parameters

builderIResourceBuilder<TResource>The Node.js app resource.

endpointNamestring?optionalThe name of the endpoint to map. If not specified, it will use the first HTTP or HTTPS endpoint found.

Returns

IResourceBuilder<TResource>A reference to the ApplicationModel.IResourceBuilder`1.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithNpm(IResourceBuilder<NxResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<NxResource>

Configures the Nx workspace to use npm as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<NxResource> WithNpm(
        this IResourceBuilder<NxResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<NxResource>The Nx workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<NxResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithNxNpm instead.

Ignored by ATS

Excluded from automatic Polyglot export.

WithNpm(IResourceBuilder<TurborepoResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<TurborepoResource>

Configures the Turborepo workspace to use npm as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TurborepoResource> WithNpm(
        this IResourceBuilder<TurborepoResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<TurborepoResource>The Turborepo workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<TurborepoResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithTurborepoNpm instead.

Ignored by ATS

Excluded from automatic Polyglot export.

WithPackageManagerLaunch(IResourceBuilder<NxResource>, string?)extensionIResourceBuilder<NxResource>

Configures the Nx workspace to use the specified JavaScript package manager when starting apps.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<NxResource> WithPackageManagerLaunch(
        this IResourceBuilder<NxResource> builder,
        string? packageManager = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<NxResource>The Nx workspace resource builder.

packageManagerstring?optionalThe package manager to use. If none is provided it will attempt to use the installer annotation's resource command.

Returns

IResourceBuilder<NxResource>A reference to the ApplicationModel.IResourceBuilder`1.

Exceptions

InvalidOperationExceptionThrown if the Nx workspace is already configured to use a different package manager.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithPackageManagerLaunch(IResourceBuilder<TurborepoResource>, string?)extensionIResourceBuilder<TurborepoResource>

Configures the Turborepo workspace to use the specified JavaScript package manager when starting apps.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TurborepoResource> WithPackageManagerLaunch(
        this IResourceBuilder<TurborepoResource> builder,
        string? packageManager = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<TurborepoResource>The Turborepo workspace resource builder.

packageManagerstring?optionalThe package manager to use. If none is provided it will attempt to use the installer annotation's resource command.

Returns

IResourceBuilder<TurborepoResource>A reference to the ApplicationModel.IResourceBuilder`1.

Exceptions

InvalidOperationExceptionThrown if the Turborepo workspace is already configured to use a different package manager.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithPnpm(IResourceBuilder<NxResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<NxResource>

Configures the Nx workspace to use pnpm as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<NxResource> WithPnpm(
        this IResourceBuilder<NxResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<NxResource>The Nx workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<NxResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithNxPnpm instead.

Ignored by ATS

Excluded from automatic Polyglot export.

WithPnpm(IResourceBuilder<TurborepoResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<TurborepoResource>

Configures the Turborepo workspace to use pnpm as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TurborepoResource> WithPnpm(
        this IResourceBuilder<TurborepoResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<TurborepoResource>The Turborepo workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<TurborepoResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithTurborepoPnpm instead.

Ignored by ATS

Excluded from automatic Polyglot export.

WithYarn(IResourceBuilder<NxResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<NxResource>

Configures the Nx workspace to use yarn as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<NxResource> WithYarn(
        this IResourceBuilder<NxResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<NxResource>The Nx workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<NxResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithNxYarn instead.

Ignored by ATS

Excluded from automatic Polyglot export.

WithYarn(IResourceBuilder<TurborepoResource>, bool, Action<IResourceBuilder<JavaScriptInstallerResource>>)extensionIResourceBuilder<TurborepoResource>

Configures the Turborepo workspace to use yarn as the package manager and optionally installs packages before apps start.

public static class JavaScriptHostingExtensions
{
    public static IResourceBuilder<TurborepoResource> WithYarn(
        this IResourceBuilder<TurborepoResource> builder,
        bool install = false,
        Action<IResourceBuilder<JavaScriptInstallerResource>>? configureInstaller = null)
    {
        // ...
    }
}

JavaScriptHostingExtensions.cs

Parameters

builderIResourceBuilder<TurborepoResource>The Turborepo workspace resource builder.

installbooloptionalWhen true, automatically installs packages before apps start. When false (default), only sets the package manager annotation without creating an installer resource.

configureInstallerAction<IResourceBuilder<JavaScriptInstallerResource>>optionalA function to configure the installer resource builder.

Returns

IResourceBuilder<TurborepoResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This overload is not available in polyglot app hosts. Use JavaScriptHostingExtensions.WithTurborepoYarn instead.

Ignored by ATS

Excluded from automatic Polyglot export.