Typely.Generators 1.4.0-alpha

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

// Install Typely.Generators as a Cake Tool
#tool nuget:?package=Typely.Generators&version=1.4.0-alpha&prerelease                

Typely lets you create types easily with a fluent API to embrace Domain-driven design and value objects.

Example

public class TypesConfiguration : ITypelyConfiguration
{
    public void Configure(ITypelyBuilder builder)
    {
        builder.OfInt().For("Votes");        
        builder.OfString().For("Code").Length(4).NotEqual("0000");
        
        builder.OfString()
            .For("UserId")
            .WithNamespace("UserAggregate")
            .WithName("Owner identifier")
            .NotEmpty()
            .NotEqual("0").WithMessage("{Name} cannot be equal to {ComparisonValue}.").WithErrorCode("ERR001")
            .MaxLength(20);

        builder.OfString()
            .For("Monday")
            .AsClass()
            .WithName(() => LocalizedNames.Moment)
            .MinLength(1).WithMessage(() => LocalizedMessages.MinLengthCustom)
            .MaxLength(20).WithMessage(() => LocalizedMessages.MaxLengthCustom);
    }
}

Documentation

Prerequisites

  • Supported .NET versions
    • .NET 7.0 and greater

Getting started

Install packages

dotnet add package Typely.Core
dotnet add package Typely.Generators

Create a class inheriting from ITypelyConfiguration

public class TypesConfiguration : ITypelyConfiguration
{
    public void Configure(ITypelyBuilder builder)
    {
        builder.OfString().For("FirstName").NotEmpty();    
    }
}

Usage

var firstName = FirstName.From("Adam");
FirstName.From(""); //Throws ValidationException

if(!FirstName.TryFrom("value", out FirstName instance, out ValidationError? validationError))
{
    // Handle error
}
There are no supported framework assets in this 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
1.8.0 108 6/9/2024
1.7.0 1,033 10/10/2023
1.6.0 1,059 10/9/2023
1.5.0 1,288 5/10/2023
1.4.6-alpha 1,043 5/2/2023
1.4.5-alpha 1,361 5/1/2023
1.4.4-alpha 1,280 5/1/2023
1.4.3-alpha 1,085 4/28/2023
1.4.2-alpha 1,362 4/28/2023
1.4.1-alpha 1,262 4/26/2023
1.4.0-alpha 1,189 4/23/2023
1.3.2-alpha 1,024 4/23/2023
1.3.1-alpha 1,122 4/19/2023
1.3.0-alpha 1,019 4/19/2023
1.2.0-alpha 1,053 4/16/2023
1.1.0-alpha 1,146 4/16/2023
0.1.0-alpha 1,205 1/16/2023