ResultCommander 2.2.1
See the version list below for details.
dotnet add package ResultCommander --version 2.2.1
NuGet\Install-Package ResultCommander -Version 2.2.1
<PackageReference Include="ResultCommander" Version="2.2.1" />
paket add ResultCommander --version 2.2.1
#r "nuget: ResultCommander, 2.2.1"
// Install ResultCommander as a Cake Addin #addin nuget:?package=ResultCommander&version=2.2.1 // Install ResultCommander as a Cake Tool #tool nuget:?package=ResultCommander&version=2.2.1
ResultCommander
Library featuring a command handler pattern for both synchronous and asynchronous operations.
Uses a functional Result approach for failure-prone operations.
To utilize all features using Autofac is required.
Features
- Synchronous and asynchronous command handler definitions
- Definitions and base implementations of commands
- Supports decorators and adapters via Autofac's methods
Description
There are two command types - one that only returns a Result and one that returns an additional entity contained within the Result.
Every handler must return a Result struct which determines whether the operation succedeed or not, handlers may or may not return additional results contained within the Result struct - this is defined by the handled comand.
Installation
To register handlers with the DI container use the ContainerBuilder
or IServiceCollection
extension methods provided by the library:
builder.AddResultCommander(assembliesToScan);
To register decorators or adapters use the methods available on ResultCommanderConfiguration like so:
builder.AddResultCommander(assembliesToScan, options =>
{
options.AddDecorator<FancyDecorator, ISyncCommandHandler<SimpleCommand>();
});
You can register multiple decorators and they'll be applied in the order that you register them - read more at Autofac's docs regarding decorators and adapters.
Documentation
Documentation available at https://mikym.github.io/ResultCommander/.
Example usage
<b> You should never throw exceptions from within handlers, they should be exception free - instead return appropriate error results (and catch possible exceptions).</b> Library offers a simple error catching, logging and exception to result error decorators for uses where writing try-catch blocks becomes a pain - but remember that these results will never be as informative as manually returned proper result error types.
A command without a concrete result:
public SimpleCommand : ICommand
{
public bool IsSuccess { get; }
public SimpleCommand(bool isSuccess = true)
=> IsSuccess = isSuccess;
}
And a synchronous handler that handles it:
public SimpleSyncCommandHandler : ISyncCommandHandler<SimpleCommand>
{
Result Handle(SimpleCommand command)
{
if (command.IsSuccess)
return Result.FromSuccess();
return new InvalidOperationError();
}
}
A command with a concrete result:
public SimpleCommandWithConcreteResult : ICommand<int>
{
public bool IsSuccess { get; }
public SimpleCommand(bool isSuccess = true)
=> IsSuccess = isSuccess;
}
And a synchronous handler that handles it:
public SimpleSyncCommandHandlerWithConcreteResult : ISyncCommandHandler<SimpleCommand, int>
{
Result<int> Handle(SimpleCommand command)
{
if (command.IsSuccess)
return 1;
return new InvalidOperationError();
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. 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 is compatible. 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 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. |
-
net6.0
- AttributeBasedRegistration (>= 2.2.2)
- Microsoft.Extensions.Options (>= 6.0.0)
- Remora.Results (>= 7.4.0)
-
net7.0
- AttributeBasedRegistration (>= 2.2.2)
- Microsoft.Extensions.Options (>= 7.0.0)
- Remora.Results (>= 7.4.0)
-
net8.0
- AttributeBasedRegistration (>= 2.2.2)
- Microsoft.Extensions.Options (>= 8.0.0)
- Remora.Results (>= 7.4.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on ResultCommander:
Package | Downloads |
---|---|
ResultCommander.Autofac
Library featuring a command handler pattern. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.2.4 | 147 | 7/23/2024 |
2.2.3 | 251 | 1/22/2024 |
2.2.2 | 247 | 11/22/2023 |
2.2.1 | 146 | 11/20/2023 |
2.2.0 | 142 | 11/20/2023 |
2.1.6 | 203 | 8/18/2023 |
2.1.5 | 192 | 8/8/2023 |
2.1.4 | 192 | 7/10/2023 |
2.1.3 | 176 | 6/25/2023 |
2.1.2 | 192 | 5/10/2023 |
2.1.1 | 209 | 4/4/2023 |
2.1.0 | 256 | 3/14/2023 |
2.0.9 | 260 | 2/21/2023 |
2.0.8 | 319 | 1/9/2023 |
2.0.7 | 285 | 1/9/2023 |
2.0.6 | 383 | 11/21/2022 |
2.0.5 | 331 | 11/21/2022 |
2.0.4 | 348 | 11/21/2022 |
2.0.3 | 349 | 11/19/2022 |
2.0.2 | 326 | 11/19/2022 |
2.0.1 | 325 | 11/19/2022 |
2.0.0 | 324 | 11/19/2022 |
1.1.17 | 423 | 9/27/2022 |
1.1.16 | 398 | 9/27/2022 |
1.1.15 | 439 | 9/26/2022 |
1.1.14 | 439 | 9/24/2022 |
1.1.13 | 398 | 9/24/2022 |
1.1.12 | 443 | 9/24/2022 |
1.1.11 | 425 | 9/24/2022 |
1.1.10 | 431 | 9/24/2022 |
1.1.9 | 427 | 9/24/2022 |
1.1.8 | 414 | 9/24/2022 |
1.1.7 | 413 | 9/24/2022 |
1.1.6 | 416 | 9/19/2022 |
1.1.5 | 430 | 9/19/2022 |
1.1.4 | 417 | 9/19/2022 |
1.1.3 | 418 | 9/19/2022 |
1.1.2 | 415 | 9/19/2022 |
1.1.0 | 442 | 9/17/2022 |
1.0.14 | 418 | 8/28/2022 |
1.0.13 | 411 | 8/24/2022 |
1.0.12 | 412 | 8/24/2022 |
1.0.11 | 407 | 8/24/2022 |
1.0.10 | 399 | 8/24/2022 |
1.0.9 | 406 | 8/24/2022 |
1.0.8 | 410 | 8/24/2022 |
1.0.7 | 409 | 8/24/2022 |
1.0.6 | 410 | 8/23/2022 |
1.0.5 | 404 | 8/23/2022 |
1.0.4 | 409 | 8/23/2022 |
1.0.3 | 411 | 8/23/2022 |
1.0.2 | 407 | 8/23/2022 |
1.0.1 | 417 | 8/22/2022 |
1.0.0 | 400 | 8/22/2022 |