Aspire.Hosting.JavaScript

Official

📦 Aspire.Hosting.JavaScriptv13.4.0

17Functions

5Types

5 types and 0 members

Types

handleBunAppResource

handleJavaScriptAppResource10 members

handleNextJsAppResource1 members

handleNodeAppResource

handleViteAppResource1 members

Functions

methodaddBunAppbuilder

Adds a Bun application to the application model. Bun should be available on the PATH.

addBunApp(name: string, appDirectory: string, scriptPath: string): BunAppResource

methodaddJavaScriptAppbuilder

Adds a JavaScript application resource to the distributed application using the specified app directory and run script.

addJavaScriptApp(name: string, appDirectory: string, runScriptName?: string): JavaScriptAppResource

methodaddNextJsAppbuilder

Adds a Next.js app to the distributed application builder.

addNextJsApp(name: string, appDirectory: string, runScriptName?: string): NextJsAppResource

methodaddNodeAppbuilder

Adds a node application to the application model. Node should be available on the PATH.

addNodeApp(name: string, appDirectory: string, scriptPath: string): NodeAppResource

methodaddViteAppbuilder

Adds a Vite app to the distributed application builder.

addViteApp(name: string, appDirectory: string, runScriptName?: string): ViteAppResource

methoddisableBuildValidationbuilder

Disables deploy-time build validation checks for the Next.js application.

disableBuildValidation(): NextJsAppResource

methodpublishAsNodeServerbuilder

Configures the JavaScript application to publish as a standalone Node.js server that runs a built artifact directly.

publishAsNodeServer(entryPoint: string, outputPath?: string): JavaScriptAppResource

methodpublishAsPackageScriptbuilder

Configures the JavaScript application to publish as a Node.js server that uses a `package.json` script at runtime.

publishAsPackageScript(scriptName?: string, runScriptArguments?: string): JavaScriptAppResource

methodpublishAsStaticWebsitebuilder

Publishes the JavaScript application as a standalone static website using YARP.

publishAsStaticWebsite(apiPath?: string, apiTarget?: IResourceWithServiceDiscovery, outputPath?: string, stripPrefix?: boolean, targetEndpointName?: string): JavaScriptAppResource

methodwithBrowserDebuggerbuilder

Configures a browser debugger for the JavaScript application resource, enabling browser-based debugging through a child resource that launches when the parent application is ready.

withBrowserDebugger(browser?: string): JavaScriptAppResource

methodwithBuildScriptbuilder

Adds a build script annotation to the resource builder using the specified command-line arguments.

withBuildScript(scriptName: string, args?: string[]): JavaScriptAppResource

methodwithBunbuilder

Configures the JavaScript resource to use Bun as the package manager and optionally installs packages before the application starts.

withBun(install?: boolean, installArgs?: string[]): JavaScriptAppResource

methodwithNpmbuilder

Configures the Node.js resource to use npm as the package manager and optionally installs packages before the application starts.

withNpm(install?: boolean, installCommand?: string, installArgs?: string[]): JavaScriptAppResource

methodwithPnpmbuilder

Configures the Node.js resource to use pnpm as the package manager and optionally installs packages before the application starts.

withPnpm(install?: boolean, installArgs?: string[]): JavaScriptAppResource

methodwithRunScriptbuilder

Adds a run script annotation to the specified JavaScript application resource builder, specifying the script to execute and its arguments during run mode.

withRunScript(scriptName: string, args?: string[]): JavaScriptAppResource

methodwithViteConfigbuilder

Configures the Vite app to use the specified Vite configuration file instead of the default resolution behavior.

withViteConfig(configPath: string): ViteAppResource

methodwithYarnbuilder

Configures the Node.js resource to use yarn as the package manager and optionally installs packages before the application starts.

withYarn(install?: boolean, installArgs?: string[]): JavaScriptAppResource