NikYo.UpdatableProperty 0.1.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package NikYo.UpdatableProperty --version 0.1.0
                    


                    

                
NuGet\Install-Package NikYo.UpdatableProperty -Version 0.1.0
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="NikYo.UpdatableProperty" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NikYo.UpdatableProperty" Version="0.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NikYo.UpdatableProperty" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add NikYo.UpdatableProperty --version 0.1.0
                    


                    

                
#r "nuget: NikYo.UpdatableProperty, 0.1.0"
#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. 
#:package NikYo.UpdatableProperty@0.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=NikYo.UpdatableProperty&version=0.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NikYo.UpdatableProperty&version=0.1.0
                    


                            Install as a Cake Tool

NikYo.UpdatableProperty

Manage updatable properties of a class.

Version

0.1.0

Installation

Run the following command in the Nuget Package Manager Console:

PM> Install-Package NikYo.UpdatableProperty

Target Framework

.NET Standard 2.0

Usage

Add [Updatable] attribute on the property that can be updated

public class Pet
{
    public string Type { get; set; } = null!;
	
    [Updatable]
    public string Name { get; set; } = null!;
    
	[Updatable(Condition = UpdateCondition.NotDefault)]
    public bool Tagged { get; set; }
    
	[Updatable(Condition = UpdateCondition.StringNotNullOrEmpty)]
    public string Color { get; set; } = null!;
    
	[Updatable(Condition = UpdateCondition.IntegerZeroOrMore)]
    public int Friends { get; set; }
    
	[Updatable(Condition = UpdateCondition.IntegerMoreThanZero)]
    public int Age { get; set; }
}

Update current object with properties of new object using UpdateWith extension.

var dog = new Pet { Type = "dog", Name = "Pochi", Color = "white", Friends = 1, Age = 2 };

Console.WriteLine($"Before: {JsonSerializer.Serialize(dog)}");

var updatedDog = new Pet { Type = "doggo", Name = "Max", Color = "brown" }; //Friends = 0, Age = 0

// Name, Color, and Friends will be updated
dog.UpdateWith(updatedDog);

Console.WriteLine($"Updated: {JsonSerializer.Serialize(dog)}");

// Name, Tagged, Age will be updated
var updatedDog2 = new Pet { Type = "doggy", Name = "Maxi", Tagged = true, Friends = -1, Age = 3 }; //Color = null

dog.UpdateWith(updatedDog2);

Console.WriteLine($"Updated2: {JsonSerializer.Serialize(dog)}");

Limitations

  • It uses reflection.
  • For loop is used over all the properties.

License

MIT License

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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
0.1.0 134 7/26/2024