Valobtify 2.1.2

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

// Install Valobtify as a Cake Tool
#tool nuget:?package=Valobtify&version=2.1.2                

Table of Contents


Overview

Valobtify is a .NET library that simplifies the creation and use of value objects and single-value objects in domain-driven design (DDD). It provides base classes and interfaces for implementing these patterns with validation and atomicity in mind.


Installation

To install the Valobtify package, run the following command in your terminal:

dotnet add package Valobtify

Ensure you have the required .NET SDK installed.


Usage

Define a value object by inheriting from ValueObject and implementing the GetAtomicValues method. This method specifies the components that uniquely identify the value object.

public class Price : ValueObject
{
    public decimal Amount { get; set; }
    public string Currency { get; set; }

    public override IEnumerable<object?> GetAtomicValues()
    {
        return new[] { Amount, Currency };
    }
}

Explanation:

  • Amount and Currency are the components that make the Price object unique.
  • GetAtomicValues ensures that equality comparisons and hashing are based on these components.

Single-Value Objects

Single-value objects represent domain concepts that encapsulate a single scalar value with validation. Valobtify simplifies their creation:

public sealed class Age : SingleValueObject<Age, int>, ICreatableValueObject<Age, int>
{
    private Age(int value) : base(value) { }

    public static Result<Age> Create(int value)
    {
        if (value < 0) return new ResultError("Age is not valid");

        return new Age(value);
    }
}

Explanation:

  • The Age class inherits from SingleValueObject<Age, int> to represent a value object with an integer value.
  • The Create method validates the value before creating an instance of Age.
  • If the value is invalid, a ResultError is returned; otherwise, a valid Age object is created.

Integration

EF Core

Valobtify integrates with EF Core, allowing you to persist value objects in your database easily. Learn more about EF Core integration.

ASP.NET Core Web API

Simplify the use of value objects in your ASP.NET Core Web API by leveraging Valobtify. Learn more about ASP.NET Core integration.

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.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Valobtify:

Package Downloads
Valobtify.AspNetCore.WebApi

A package for handling value objects in ASP.NET Core Web API with automatic mapping.

Valobtify.EFCore.Core

Core of Valobtify.EFCore nuget pacakges

Valobtify.Swagger.FastEndpoints

Integrate Valobtify with Swagger and FastEndpoints

Valobtify.Swagger

Provides seamless integration between Valobtify value objects and Swagger documentation in ASP.NET Core.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.0 110 12/9/2024
2.1.3 88 12/5/2024
2.1.2 88 12/5/2024
2.1.1 109 11/27/2024
2.1.0 75 11/27/2024
2.0.3 100 11/26/2024
2.0.2 88 11/26/2024
2.0.1 157 10/14/2024
2.0.0 108 10/3/2024
1.1.1 142 8/20/2024
1.1.0 113 8/20/2024
1.0.32 163 8/17/2024
1.0.31 137 8/17/2024
1.0.6 110 8/20/2024
1.0.5 113 8/20/2024
1.0.4 116 8/20/2024
1.0.3 127 8/13/2024
1.0.2 111 7/13/2024
1.0.1 113 7/13/2024
1.0.0 124 6/10/2024