JavaScriptAppResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.JavaScript / JavaScriptAppResource

JavaScriptAppResource

Docs Reference TypeScript APIs Aspire.Hosting.JavaScript JavaScriptAppResource

Handle TypeScript

📦 Aspire.Hosting.JavaScript v13.2.0-preview.1.26159.1

interface JavaScriptAppResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IResourceWithContainerFiles,
    IResourceWithServiceDiscovery {
  readonly command: string;
  readonly name: string;
  readonly workingDirectory: string;
  withBrowserDebugger(browser?: string): JavaScriptAppResource;
  withBuildScript(
      scriptName: string,
      args?: string[]): JavaScriptAppResource;
  withBun(
      install?: boolean,
      installArgs?: string[]): JavaScriptAppResource;
  withDebugging(): JavaScriptAppResource;
  withNpm(
      install?: boolean,
      installCommand?: string,
      installArgs?: string[]): JavaScriptAppResource;
  withPnpm(
      install?: boolean,
      installArgs?: string[]): JavaScriptAppResource;
  withRunScript(
      scriptName: string,
      args?: string[]): JavaScriptAppResource;
  withYarn(
      install?: boolean,
      installArgs?: string[]): JavaScriptAppResource;
}

Implements

• IComputeResource
• IResource
• IResourceWithArgs
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IResourceWithContainerFiles
• IResourceWithServiceDiscovery

Search members of JavaScriptAppResource…

method property

11 members Clear filters

Properties

property command string get

Gets the Command property

property name string get

Gets the Name property

property workingDirectory string get

Gets the WorkingDirectory property

Methods

method withBrowserDebugger builder

Configures browser debugging support

withBrowserDebugger(browser?: string): JavaScriptAppResource

Parameters

browser string optional = msedge

Returns

JavaScriptAppResource

method withBuildScript builder

Specifies an npm script to run before starting the application

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

Parameters

scriptName string

args string[] optional

Returns

JavaScriptAppResource

method withBun builder

Configures Bun as the package manager

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

Parameters

install boolean optional = True

installArgs string[] optional

Returns

JavaScriptAppResource

method withDebugging builder

Enables debugging support for a JavaScript application

withDebugging(): JavaScriptAppResource

Returns

JavaScriptAppResource

method withNpm builder

Configures npm as the package manager

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

Parameters

install boolean optional = True

installCommand string optional

installArgs string[] optional

Returns

JavaScriptAppResource

method withPnpm builder

Configures pnpm as the package manager

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

Parameters

install boolean optional = True

installArgs string[] optional

Returns

JavaScriptAppResource

method withRunScript builder

Specifies an npm script to run during development

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

Parameters

scriptName string

args string[] optional

Returns

JavaScriptAppResource

method withYarn builder

Configures yarn as the package manager

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

Parameters

install boolean optional = True

installArgs string[] optional

Returns

JavaScriptAppResource