FastProjects.ResultPattern 1.0.7

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

// Install FastProjects.ResultPattern as a Cake Tool
#tool nuget:?package=FastProjects.ResultPattern&version=1.0.7                

πŸš€ FastProjects.ResultPattern

Build Status NuGet NuGet Downloads License Last Commit GitHub Stars GitHub Forks

🚨 ALERT: Project Under Development This project is not yet production-ready and is still under active development. Currently, it's being used primarily for personal development needs. However, contributions are more than welcome! If you'd like to collaborate, feel free to submit issues or pull requests. Your input can help shape the future of FastProjects!


πŸ“š Overview

Result pattern implementation with IActionResult mapping for ASP.NET Core.


πŸ›  Roadmap


πŸš€ Installation

You can download the NuGet package using the following command to install:

dotnet add package FastProjects.ResultPattern

πŸ“– Usage

Basic usage example:

public async Task<Result<User>> GetByIdAsync(Guid id)
{
    var user = await _userRepository.GetAsync(id);
    if (user is null)
    {
        return Result.NotFound($"User with {id} not found.");
    }

    return Result.Success(user);
}

Translation of the result to IActionResult (example with FastEndpoints usage):

public override async Task HandleAsync(
    GetUserByIdRequest request,
    CancellationToken ct)
{
    var command = new GetUserByIdQuery(request.UserId);

    var result = await mediator.Send(command, ct);
    
    if (result.IsSuccess)
    {
        Response = new GetUserByIdResponse(
            Id: result.Value.Id,
            Name: result.Value.Name);
    }
    else
    {
        await SendResultAsync(result.ToWebResult());
    }
}

🀝 Contributing

This project is still under development, but contributions are welcome! Whether you’re opening issues, submitting pull requests, or suggesting new features, we appreciate your involvement. For more details, please check the contribution guide. Let’s build something amazing together! πŸŽ‰


πŸ“„ License

FastProjects is licensed under the MIT License. See the LICENSE file for full details.

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.
  • net8.0

    • No dependencies.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on FastProjects.ResultPattern:

Package Downloads
FastProjects.SharedKernel

useful base classes that are used in Clean Architecture templates with DDD

FastProjects.Endpoints

Collection of endpoint base classes that wraps FastEndpoints classes and integrated with MediatR and Result patterns.

FastProjects.Caching

Collection of interfaces to work with cache.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.7 848 9/16/2024
1.0.5 121 9/16/2024
1.0.4 87 9/16/2024
1.0.3 278 9/11/2024
1.0.2 121 9/7/2024
1.0.1 144 9/6/2024
1.0.0 124 9/5/2024