ModularFramework.Utilities.PartialObject 1.0.1

Prefix Reserved

dotnet add package ModularFramework.Utilities.PartialObject --version 1.0.1

NuGet\Install-Package ModularFramework.Utilities.PartialObject -Version 1.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="ModularFramework.Utilities.PartialObject" Version="1.0.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ModularFramework.Utilities.PartialObject" Version="1.0.1" />
                    

                            Directory.Packages.props

<PackageReference Include="ModularFramework.Utilities.PartialObject" />
                    

                            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 ModularFramework.Utilities.PartialObject --version 1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ModularFramework.Utilities.PartialObject, 1.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.

#:package ModularFramework.Utilities.PartialObject@1.0.1

#: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=ModularFramework.Utilities.PartialObject&version=1.0.1
                    

                            Install as a Cake Addin

#tool nuget:?package=ModularFramework.Utilities.PartialObject&version=1.0.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ModularFramework.Utilities.PartialObject introduces PartialObject<T> to read and write properties of T partially.

This package is designed to support Patch updates to POCOs (Plain Old CLR Objects) with explicitly defined properties that are safe to read and modify.

Usage

Call the Patch method with the target object to apply changes.

public void Usage()
{
    var person = new Person { Name = "John", LastName = "Doe", Email = "john.doe@gmail.com" };
    var partialObject = new PartialObject<Person>();
    // Expression Indexer Access
    partialObject[x => x.Name] = "Jane";
    // String Indexer Access
    partialObject["LastName"] = "Smith";
    // Dynamic Access
    ((dynamic)partialObject).Email = "jane.smith@gmail.com";
    // Apply Changes
    partialObject.Patch(person);
    // Test
    person.Name.ShouldBe("Jane");
    person.LastName.ShouldBe("Smith");
    person.Email.ShouldBe("jane.smith@gmail.com");
}

System.Text.Json

Call the RegisterPartialObjectMetadata method to support PartialObject<T> serialization and deserialization.

public void Register(JsonSerializerOptions options)
{
    options.RegisterPartialObjectMetadata();
}

JSON Patch support in ASP.NET Core web API

[HttpPatch("{id}")]
public IActionResult Update(AppDb db, IValidator validator, string id, [FromBody] PartialObject<Customer> partialCustomer)
{
    // Retrieve the customer by ID
    var customer = db.Customers.FirstOrDefault(c => c.Id == id);

    // Return 404 Not Found if customer doesn't exist
    if (customer == null)
    {
        return NotFound();
    }

    partialCustomer.Patch(customer);

    // Validate the patched object after applying changes
    // to ensure business rules and invariants aren't violated.
    validator.Validate(customer, ModelState);

    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    return new ObjectResult(customer);
}

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. 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.

net10.0
- ModularFramework.Utilities.Runtime (>= 1.0.2)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.