ilandev.AspNetCore.ExceptionHandler 0.1.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package ilandev.AspNetCore.ExceptionHandler --version 0.1.2
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ilandev.AspNetCore.ExceptionHandler" />
                    


                            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 ilandev.AspNetCore.ExceptionHandler --version 0.1.2
                    


                    

                
#r "nuget: ilandev.AspNetCore.ExceptionHandler, 0.1.2"
#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 ilandev.AspNetCore.ExceptionHandler@0.1.2
#: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=ilandev.AspNetCore.ExceptionHandler&version=0.1.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ilandev.AspNetCore.ExceptionHandler&version=0.1.2
                    


                            Install as a Cake Tool

ilandev.AspNetCore.ExceptionHandler

nuget.org

Customizable exception mapping middleware for ASP.NET Core. Allows you to specify custom response lambdas for specific exception types.

Usage

  1. Call builder.Services.AddExceptionHandlingMiddleware() and pass in a configuration action to configure the middleware.
  2. Call app.UseExceptionHandlingMiddleware() after the call to app.UseRouting().

Examples

builder.Services.AddExceptionHandlingMiddleware(c => c
	.AddHandler<UserNotFoundException>(e => new ExceptionMapping
	{
		StatusCode = HttpStatusCode.BadRequest,
		Response = new
		{
			ErrorCode = "user_not_found"
		}
	})
);

// ...

app.UseExceptionHandlingMiddleware();

Any exceptions thrown of type UserNotFoundException (or any exceptions inheriting from this type) will cause the above-mentioned response to be written.

Middleware Configuration

Configuration Default Value Details
IgnoreTaskCancellation true Exceptions of type TaskCanceledException will be ignored, and a default response will be written instead.
AllowExceptionInheritance true Whether to look for exception base classes when matching a handler.
JsonSerializerOptions null Custom JsonSerializerOptions to use when writing the response.
WriteExceptionDetails false Whether to print the exception message & stack trace when writing the default response.
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 was computed.  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.

  • net8.0

    • No dependencies.

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
0.1.2 265 1/26/2024
0.1.1 187 1/9/2024
0.1.0 195 12/22/2023