SgtMapper 1.0.0

.NET Core 2.2 This package targets .NET Core 2.2. The package is compatible with this framework or higher. 
dotnet add package SgtMapper --version 1.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SgtMapper" />
                    


                            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 SgtMapper --version 1.0.0
                    


                    

                
#r "nuget: SgtMapper, 1.0.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 SgtMapper@1.0.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=SgtMapper&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SgtMapper&version=1.0.0
                    


                            Install as a Cake Tool

Sgt. Mapper's Lonely Exceptions Band

Uncomplicated exception mapping for ASP.NET Core.

What does it do

SgtMapper is installed as a middleware in your application which automatically catches uncaught exceptions and maps it to a response using one of the user-defined exception mappers.

How to use it

  1. Add the nuget package.
dotnet app package SgtMapper
  1. Configure SgtMapper in your Startup.cs.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        ...
        app.WithSgtMapper();
    }
  1. Define custom exception mappers.
[ExceptionMapper]
  public class MyExceptionMapper : ExceptionMapper<MyException> {
    public object Map(MyException exception) {
      return new { Message = "got a simple exception!" };
    }
  }

Advanced Settings

None! SgtMapper is designed to be as simple to use as possible. There is nothing more to configure than what is described in this README. Exception mappers will be automatically detected in your project, and will be instantiated directly, or using ASP.NET's dependency injection mechanism, should they require constructor parameters.

Running the tests

Sgt. Mapper has an Anachronos testing suite which can be found in the e2e_tests directory. Running the tests requires python3.6 or later.

pip install -r e2e_tests/requirements.txt
sh run_tests.sh
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.2 is compatible.  netcoreapp3.0 was computed.  netcoreapp3.1 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
1.0.0 710 3/8/2020
0.0.3 682 2/25/2020
0.0.2 634 2/23/2020
0.0.1 663 2/21/2020