Convex.Client.AspNetCore 5.2.5-beta

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Convex.Client.AspNetCore. 
dotnet add package Convex.Client.AspNetCore --version 5.2.5-beta
                    


                    

                
NuGet\Install-Package Convex.Client.AspNetCore -Version 5.2.5-beta
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="Convex.Client.AspNetCore" Version="5.2.5-beta" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Convex.Client.AspNetCore" Version="5.2.5-beta" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Convex.Client.AspNetCore" />
                    


                            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 Convex.Client.AspNetCore --version 5.2.5-beta
                    


                    

                
#r "nuget: Convex.Client.AspNetCore, 5.2.5-beta"
#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 Convex.Client.AspNetCore@5.2.5-beta
#: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=Convex.Client.AspNetCore&version=5.2.5-beta&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Convex.Client.AspNetCore&version=5.2.5-beta&prerelease
                    


                            Install as a Cake Tool

Convex.Client.AspNetCore

ASP.NET Core extensions for the Convex .NET Client.

Features

  • Authentication Middleware - Automatic token validation and user context
  • Health Checks - Monitor Convex connection status in your health endpoints
  • Server-side Integration - Optimized for ASP.NET Core applications

Installation

dotnet add package Convex.Client.AspNetCore

Quick Start

Basic Setup

// In Program.cs
builder.Services.AddConvex(options =>
{
    options.DeploymentUrl = "https://your-deployment.convex.cloud";
});

// Add health checks
builder.Services.AddHealthChecks()
    .AddConvexHealthCheck();

// Configure the HTTP request pipeline
app.UseConvexAuth(); // Optional: validates auth tokens
app.MapHealthChecks("/health");

Health Checks

// Register Convex health check
builder.Services.AddHealthChecks()
    .AddConvexHealthCheck(
        name: "convex",
        tags: new[] { "ready", "live" });

Authentication Middleware

// Add authentication middleware
app.UseConvexAuth();

// Access user context in controllers
[ApiController]
public class MyController : ControllerBase
{
    [HttpGet]
    public IActionResult Get()
    {
        var userId = HttpContext.Items["ConvexUserId"];
        // ...
    }
}

License

MIT

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 was computed.  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

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
5.2.5-beta 78 5/3/2026
5.2.4-beta 88 2/17/2026
5.2.3-beta 90 2/7/2026
5.2.2-beta 89 2/7/2026
5.2.1-beta 80 2/3/2026
5.1.0-beta 181 12/4/2025
5.0.0-beta 170 12/4/2025
4.2.0-alpha 640 12/3/2025
4.1.0-alpha 642 12/3/2025
4.0.1-alpha 646 12/2/2025
4.0.0-alpha 654 12/2/2025

See `CHANGELOG.md` for release details.