magic.library 17.3.9

dotnet add package magic.library --version 17.3.9
NuGet\Install-Package magic.library -Version 17.3.9
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="magic.library" Version="17.3.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add magic.library --version 17.3.9
#r "nuget: magic.library, 17.3.9"
#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.
// Install magic.library as a Cake Addin
#addin nuget:?package=magic.library&version=17.3.9

// Install magic.library as a Cake Tool
#tool nuget:?package=magic.library&version=17.3.9

magic.library - Tying Magic together

This project helps you to wire up everything related to Magic. Normally you'd use it simply like the following from your startup class in your .Net 8 Web API project.

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using magic.library;

namespace magic.backend
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            // Initializing Magic.
            services.AddMagic(Configuration);
        }

        public void Configure(IApplicationBuilder app)
        {
            // Initializing Magic.
            app.UseMagic(Configuration);
        }
    }
}

However, you can also take more control over how things are actually wired up, by instead of using the "do all methods" called AddMagic and UseMagic, invoke some of the specialized initialization methods, you can find below.

  • IServiceCollection.AddMagicCaching
  • IServiceCollection.AddMagicHttp
  • IServiceCollection.AddMagicLogging
  • IServiceCollection.AddMagicSignals
  • IServiceCollection.AddMagicExceptions
  • IServiceCollection.AddMagicEndpoints
  • IServiceCollection.AddMagicAuthorization
  • IServiceCollection.AddMagicFileServices
  • IServiceCollection.AddMagicFileServices
  • IServiceCollection.AddMagicConfiguration
  • IServiceCollection.AddMagicScheduler
  • IServiceCollection.AddMagicMail
  • IServiceCollection.AddMagicLambda
  • IServiceCollection.AddMagicSockets

The above methods is basically what the AddMagic method actually does, and they're extension methods of IServiceCollection, that can be found in the magic.library namespace. Similar alternatives to UseMagic can be found below.

  • IApplicationBuilder.UseMagicExceptions
  • IApplicationBuilder.UseMagicStartupFiles
  • IApplicationBuilder.UseMagicScheduler
  • IApplicationBuilder.UseMagicCors

If you use these methods instead of the "do all methods", your motivation would probably be to replace one of these methods with your own implementation, to exchange the default wiring, by (for instance) using a "virtual database based file system" by creating your own service implementation of for instance IFileService from "magic.lambda.io", or use a different logging provider than the default, etc. If you wish to do this, you'd probably benefit from looking at what the default implementation of your method does, to understand the requirements from your method. Doing this is very powerful, and allows you to change the way the system behaves by default - But is also definitely considered an "advanced exercise".

Exceptions handlers

Magic allows you to provide a custom exceptions handler on a per folder level. This overrides the default exception logic with a custom exception handler expected to be named "exceptions.hl" and found within the folder hierarchy where an HTTP invocation is resolved. For instance, if you wish to create your own exception handler for a specific module called "foo", you can create an exception handler file called "/files/modules/foo/exceptions.hl", and expect this file to be invoked every time an unhandled exception occurs, anywhere inside of your "foo" folder. This allows you to transform an unhandled exception, such as for instance localising it or customising it in any ways. Your custom exception handler will be invoked with the following arguments.

  • [message] - The exception error message
  • [path] - The URL that triggered the exception
  • [field] - If the exception that was thrown declared a field, this argument will contain the name of the field
  • [status] - If the exception that was thrown declared a status code, this argument will contain the status code
  • [public] - If the exception that was thrown wants to propagate to the client this will be true

You can return a "transformed" exception from your exception handler, returning the following arguments, that will end up becoming the response object returned to the client.

  • [message] - Message to return as JSON to client
  • [field] - Field to return as JSON to client
  • [status] - Status code to decorate your HTTP response with

The default exception handler can be found in "/files/exceptions.hl", which will be invoked if no custom exception handler is declared further down in your folder hierarchy.

Magic's GitHub project page

Magic is 100% Open Source and you can find the primary project GitHub page here.

Project website for magic.lambda.library

The source code for this repository can be found at github.com/polterguy/magic.library, and you can provide feedback, provide bug reports, etc at the same place.

  • Build status
  • Quality Gate Status
  • Bugs
  • Code Smells
  • Duplicated Lines (%)
  • Lines of Code
  • Maintainability Rating
  • Reliability Rating
  • Security Rating
  • Technical Debt
  • Vulnerabilities

The projects is copyright Thomas Hansen 2023 - 2024, and professionally maintained by AINIRO.IO.

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. 
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
17.3.9 105 2/17/2024
17.3.7 121 2/12/2024
17.3.6 86 2/12/2024
17.3.5 83 2/10/2024
17.3.4 87 2/9/2024
17.3.3 81 2/8/2024
17.3.2 93 2/2/2024
17.3.1 97 1/30/2024
17.2.2 80 1/30/2024
17.2.1 108 1/22/2024
17.2.0 81 1/22/2024
17.1.7 151 1/12/2024
17.1.6 115 1/11/2024
17.1.5 136 1/5/2024
17.0.1 176 1/1/2024
17.0.0 314 12/14/2023
16.11.6 212 11/14/2023
16.11.5 153 11/12/2023
16.9.0 278 10/9/2023
16.8.5 161 9/30/2023
16.8.4 155 9/25/2023
16.8.0 126 9/24/2023
16.7.51 116 9/24/2023
16.7.50 124 9/23/2023
16.7.1 177 9/4/2023
16.7.0 289 7/11/2023
16.6.13 180 7/6/2023
16.6.12 175 7/5/2023
16.6.11 162 7/5/2023
16.6.5 201 7/3/2023
16.4.4 199 7/2/2023
16.4.3 217 6/27/2023
16.4.2 200 6/25/2023
16.4.1 201 6/25/2023
16.4.0 187 6/22/2023
16.3.2 280 6/7/2023
16.3.0 283 5/28/2023
16.2.0 366 5/13/2023
16.1.10 356 5/1/2023
16.1.9 273 4/30/2023
16.1.1 287 4/20/2023
15.10.11 318 4/16/2023
15.9.40 339 4/3/2023
15.9.1 390 3/27/2023
15.9.0 412 3/24/2023
15.8.2 443 3/20/2023
15.7.0 326 3/6/2023
15.5.20 684 2/23/2023
15.5.13 484 2/13/2023
15.5.9 378 2/11/2023
15.5.2 460 2/5/2023
15.5.1 382 2/3/2023
15.5.0 457 1/28/2023
15.2.0 601 1/18/2023
15.1.0 1,064 12/28/2022
14.5.7 610 12/13/2022
14.5.5 711 12/6/2022
14.5.1 545 11/23/2022
14.5.0 492 11/18/2022
14.4.5 565 10/22/2022
14.4.2 500 10/22/2022
14.4.1 497 10/22/2022
14.4.0 524 10/17/2022
14.3.9 547 10/13/2022
14.3.6 556 10/7/2022
14.3.2 557 9/18/2022
14.3.1 647 9/12/2022
14.3.0 531 9/10/2022
14.1.3 799 8/7/2022
14.1.2 546 8/7/2022
14.1.1 555 8/7/2022
14.0.14 544 7/26/2022
14.0.12 532 7/24/2022
14.0.11 518 7/23/2022
14.0.10 527 7/23/2022
14.0.9 517 7/23/2022
14.0.8 603 7/17/2022
14.0.5 673 7/11/2022
14.0.4 605 7/7/2022
14.0.3 597 7/2/2022
14.0.2 542 7/2/2022
14.0.1 587 7/2/2022
14.0.0 567 6/25/2022
13.4.28 560 6/11/2022
13.4.25 663 6/9/2022
13.4.24 561 6/9/2022
13.4.19 606 6/8/2022
13.4.3 582 6/6/2022
13.4.2 620 6/4/2022
13.4.0 646 5/31/2022
13.3.8 621 5/19/2022
13.3.7 580 5/18/2022
13.3.6 623 5/14/2022
13.3.4 691 5/9/2022
13.3.1 632 5/1/2022
13.3.0 593 5/1/2022
13.2.2 648 4/25/2022
13.2.1 605 4/25/2022
13.2.0 633 4/21/2022
13.1.1 653 4/20/2022
13.1.0 712 4/7/2022
13.0.0 663 4/5/2022
12.0.3 824 3/14/2022
11.0.7 702 3/11/2022
11.0.5 746 3/2/2022
11.0.4 672 2/22/2022
11.0.3 680 2/9/2022
11.0.2 733 2/6/2022
11.0.1 725 2/5/2022
10.0.21 693 1/28/2022
10.0.20 711 1/27/2022
10.0.19 690 1/23/2022
10.0.18 663 1/17/2022
10.0.17 676 1/14/2022
10.0.16 528 1/2/2022
10.0.15 585 12/31/2021
10.0.14 597 12/28/2021
10.0.13 667 12/23/2021
10.0.11 458 12/23/2021
10.0.10 477 12/22/2021
10.0.9 635 12/22/2021
10.0.8 516 12/22/2021
10.0.7 679 12/22/2021
10.0.6 556 12/19/2021
10.0.5 651 12/18/2021
10.0.3 441 12/16/2021
10.0.2 514 12/14/2021
10.0.1 406 12/13/2021
10.0.0 451 12/6/2021
9.9.9 1,243 11/29/2021
9.9.6 4,703 11/24/2021
9.9.5 455 11/23/2021
9.9.4 759 11/21/2021
9.9.3 522 11/9/2021
9.9.2 542 11/4/2021
9.9.0 642 10/30/2021
9.8.9 664 10/29/2021
9.8.7 557 10/27/2021
9.8.6 551 10/27/2021
9.8.5 667 10/26/2021
9.8.4 624 10/25/2021
9.8.3 683 10/24/2021
9.8.1 554 10/21/2021
9.8.0 629 10/20/2021
9.7.9 543 10/20/2021
9.7.8 576 10/19/2021
9.7.7 809 10/17/2021
9.7.6 697 10/17/2021
9.7.5 580 10/14/2021
9.7.1 518 10/14/2021
9.7.0 587 10/9/2021
9.6.8 599 8/30/2021
9.6.7 576 8/26/2021
9.6.6 685 8/14/2021
9.6.5 790 8/11/2021
9.6.4 591 8/10/2021
9.6.3 592 8/9/2021
9.6.2 565 8/8/2021
9.6.1 532 8/8/2021
9.5.9 729 8/5/2021
9.5.8 725 8/4/2021
9.5.3 609 7/20/2021
9.5.0 975 7/9/2021
9.4.5 590 6/29/2021
9.4.4 740 6/29/2021
9.4.0 573 6/24/2021
9.3.7 591 6/21/2021
9.3.6 644 6/21/2021
9.3.5 771 6/18/2021
9.3.4 702 6/18/2021
9.2.5 749 6/7/2021
9.2.4 681 6/6/2021
9.2.3 625 6/6/2021
9.2.2 533 6/4/2021
9.2.1 759 6/1/2021
9.2.0 727 5/26/2021
9.1.9 539 5/5/2021
9.1.8 687 5/5/2021
9.1.7 554 5/3/2021
9.1.4 563 4/21/2021
9.1.2 545 4/18/2021
9.1.1 531 4/15/2021
9.1.0 580 4/14/2021
9.0.1 651 4/12/2021
9.0.0 548 4/5/2021
8.9.92 1,129 3/30/2021
8.9.4 1,132 3/26/2021
8.9.3 1,162 3/19/2021
8.9.2 1,156 1/29/2021
8.9.1 1,217 1/24/2021
8.9.0 1,283 1/22/2021
8.7.1 1,586 11/15/2020
8.7.0 1,293 11/15/2020
8.6.9 1,229 11/8/2020
8.6.7 1,204 11/4/2020
8.6.6 1,296 11/2/2020
8.6.5 1,263 11/1/2020
8.6.3 1,284 10/30/2020
8.6.2 1,201 10/30/2020
8.6.1 1,283 10/29/2020
8.6.0 1,236 10/28/2020
8.5.1 1,224 10/26/2020
8.5.0 1,190 10/23/2020
8.4.6 1,399 10/20/2020
8.4.5 1,278 10/18/2020
8.4.4 1,296 10/17/2020
8.4.3 1,273 10/16/2020
8.4.2 1,220 10/16/2020
8.4.1 1,220 10/15/2020
8.4.0 1,301 10/13/2020
8.3.3 1,217 10/11/2020
8.3.2 1,266 10/8/2020
8.3.1 1,281 10/5/2020
8.3.0 1,234 10/3/2020
8.2.3 1,175 10/1/2020
8.2.2 1,465 9/26/2020
8.2.1 1,329 9/25/2020
8.2.0 1,358 9/25/2020
8.1.25 1,259 9/24/2020
8.1.24 1,260 9/23/2020
8.1.23 1,187 9/23/2020
8.1.22 1,251 9/21/2020
8.1.21 1,304 9/15/2020
8.1.20 1,312 9/14/2020
8.1.19 1,298 9/13/2020
8.1.18 1,250 9/13/2020
8.1.17 1,308 9/13/2020
8.1.16 1,297 9/13/2020
8.1.15 1,221 9/12/2020
8.1.13 1,124 9/11/2020
8.1.12 1,251 9/11/2020
8.1.11 1,248 9/11/2020
8.1.10 1,291 9/6/2020
8.1.9 1,297 9/3/2020
8.1.8 1,329 9/2/2020
8.1.7 1,184 8/28/2020
8.1.4 1,181 8/25/2020
8.1.3 1,362 8/18/2020
8.1.2 1,180 8/16/2020
8.1.1 1,240 8/15/2020
8.0.3 1,254 8/11/2020
8.0.2 1,277 8/7/2020
8.0.1 1,282 8/7/2020
8.0.0 1,228 8/7/2020
7.0.1 1,344 6/28/2020
7.0.0 1,323 6/28/2020
5.0.10 1,293 5/31/2020
5.0.9 1,382 5/30/2020
5.0.8 1,275 5/29/2020
5.0.7 1,234 5/29/2020
5.0.5 1,344 2/27/2020
5.0.4 1,301 2/26/2020
5.0.3 1,302 2/26/2020
5.0.2 1,309 2/25/2020
5.0.1 1,196 2/25/2020
5.0.0 1,319 2/25/2020
4.1.5 1,260 2/23/2020
4.1.4 1,343 2/23/2020
4.1.3 1,278 2/22/2020
4.1.2 1,270 2/22/2020
4.1.1 1,258 2/21/2020
4.1.0 1,297 2/21/2020
4.0.9 1,385 2/7/2020
4.0.8 1,218 2/7/2020
4.0.7 1,241 2/7/2020
4.0.5 1,263 1/28/2020
4.0.4 1,386 1/27/2020
4.0.3 1,238 1/27/2020
4.0.2 1,380 1/16/2020
4.0.1 1,393 1/11/2020
4.0.0 1,351 1/5/2020
3.1.7 1,395 12/17/2019
3.1.6 1,300 12/12/2019
3.1.5 1,286 12/12/2019
3.1.4 1,310 12/5/2019
3.1.3 1,334 12/4/2019
3.1.2 1,354 11/30/2019
3.1.1 1,511 11/26/2019
3.1.0 1,313 11/10/2019
3.0.4 1,155 11/1/2019
3.0.3 1,328 10/28/2019
3.0.2 1,340 10/28/2019
3.0.1 1,331 10/26/2019
3.0.0 1,152 10/23/2019
2.1.4 951 10/21/2019
2.1.3 1,286 10/21/2019
2.1.2 1,420 10/21/2019
2.1.1 1,297 10/19/2019
2.1.0 1,343 10/19/2019
2.0.9 1,047 10/18/2019
2.0.8 1,318 10/18/2019
2.0.7 1,046 10/18/2019
2.0.6 1,051 10/18/2019
2.0.5 1,085 10/18/2019
2.0.4 1,051 10/17/2019
2.0.3 1,182 10/16/2019
2.0.2 1,174 10/15/2019
2.0.1 1,215 10/14/2019
2.0.0 922 10/13/2019
1.1.7 1,373 10/11/2019
1.1.6 1,330 10/11/2019