CommunityToolkit.Aspire.Hosting.Bun 13.5.0

Prefix Reserved
Suggested Alternatives

Aspire.Hosting.JavaScript 13.5.0

Additional Details

As of Aspire 13.5.0, Bun hosting is built into the Aspire.Hosting.JavaScript integration

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package CommunityToolkit.Aspire.Hosting.Bun --version 13.5.0
                    
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.Bun -Version 13.5.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Bun" Version="13.5.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CommunityToolkit.Aspire.Hosting.Bun" Version="13.5.0" />
                    
Directory.Packages.props
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Bun" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CommunityToolkit.Aspire.Hosting.Bun --version 13.5.0
                    
#r "nuget: CommunityToolkit.Aspire.Hosting.Bun, 13.5.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CommunityToolkit.Aspire.Hosting.Bun@13.5.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CommunityToolkit.Aspire.Hosting.Bun&version=13.5.0
                    
Install as a Cake Addin
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Bun&version=13.5.0
                    
Install as a Cake Tool

CommunityToolkit.Aspire.Hosting.Bun library

⚠️ DEPRECATION NOTICE
This package is deprecated. Bun support is now available in the core Aspire.Hosting.JavaScript package via AddBunApp(...).

Migration Guide:

  • Install Aspire.Hosting.JavaScript and remove CommunityToolkit.Aspire.Hosting.Bun.
  • Review existing builder.AddBunApp(...) calls carefully: if you pass arguments positionally, you may need to reorder them or convert them to named arguments when moving to the core package implementation.
  • If you're using TypeScript AppHost bindings, continue using builder.addBunApp(...) from the generated core bindings.

This package will be removed in a future release. Please migrate to Aspire.Hosting.JavaScript.

Provides extension methods and resource definitions for an Aspire AppHost to configure a Bun project.

Getting Started

Install the package

In your AppHost project, install the package using the following command:

dotnet add package CommunityToolkit.Aspire.Hosting.Bun

Example usage

Then, in the Program.cs file of AppHost, define a Bun resource, then call AddBunApp:

builder.AddBunApp("bun-server", "main.ts")
    .WithHttpEndpoint(env: "PORT")
    .WithEndpoint();

Migration from Toolkit Bun to core Bun

Toolkit API:

builder.AddBunApp("api", "server.ts")
    .WithHttpEndpoint(env: "PORT");

Core API (Aspire.Hosting.JavaScript):

builder.AddBunApp("api", "./api", "server.ts")
    .WithHttpEndpoint(env: "PORT")
    .WithExternalHttpEndpoints();

TypeScript AppHost (core bindings):

await builder
    .addBunApp("api", "./api", "server.ts")
    .withHttpEndpoint({ env: "PORT" })
    .withExternalHttpEndpoints();

Additional Information

https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-bun

Feedback & contributing

https://github.com/CommunityToolkit/Aspire

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on CommunityToolkit.Aspire.Hosting.Bun:

Repository Stars
suxrobGM/logistics-app
AI-powered fleet management platform with an agentic dispatcher that matches loads to trucks, ensures HOS compliance, and optimizes routes. Built for trucking companies.