TS.Result 8.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package TS.Result --version 8.0.1                
NuGet\Install-Package TS.Result -Version 8.0.1                
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="TS.Result" Version="8.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TS.Result --version 8.0.1                
#r "nuget: TS.Result, 8.0.1"                
#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 TS.Result as a Cake Addin
#addin nuget:?package=TS.Result&version=8.0.1

// Install TS.Result as a Cake Tool
#tool nuget:?package=TS.Result&version=8.0.1                

TS.Result NuGet Package

Overview

The TS.Result package is designed to encapsulate the result of operations in .NET applications, offering a structured way to handle success and failure states with associated data or error messages. It is ideal for improving error handling and response consistency across various application layers.

Features

  • Generic Result Type: Facilitates strong typing of the operation outcome, accommodating any data type.
  • Error Handling: Enables capturing multiple error messages, suitable for scenarios requiring detailed feedback.
  • HTTP Status Code Integration: Aligns operation results with HTTP response standards, enhancing API development.
  • Implicit Conversions: Streamlines result creation from data or errors through implicit conversion operators.

Getting Started

Installation

To integrate TS.Result into your project, install it via the NuGet package manager:

Install-Package TS.Result

Or through the .NET CLI:

dotnet add package TS.Result

Usage

  • For a successful operation, instantiate a Result object with the desired data:
var successResult = new Result<string>("Operation successful.");
  • Alternatively, leverage implicit conversion from data:
Result<string> result = "Operation successful.";
  • For failures, create a Result object with an HTTP status code and error messages:
var errorResult = new Result<string>(HttpStatusCode.BadRequest, new List<string> { "Error 1", "Error 2" });
  • Or use implicit conversion from error details:
Result<string> result = (HttpStatusCode.BadRequest, new List<string> { "Error 1", "Error 2" });
  • For single error messages:
Result<string> result = (HttpStatusCode.BadRequest, "Single error message");

Contributing

We welcome contributions! Feel free to open an issue or submit a pull request on our GitHub repository for any suggestions or improvements.

License

TS.Result is licensed under the MIT License. See the LICENSE file in the source repository for full details.

This Markdown formatted README provides a comprehensive guide on how to use the `TS.Result` package, suitable for your project's repository or documentation.

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

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
8.0.8 124 9/29/2024
8.0.7 81 9/29/2024
8.0.6 743 4/20/2024
8.0.5 276 3/3/2024
8.0.4 129 2/28/2024
8.0.3 132 2/28/2024
8.0.2 136 2/25/2024
8.0.1 126 2/25/2024
8.0.0 120 2/25/2024