Oakrey.Parameters 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Oakrey.Parameters --version 1.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Oakrey.Parameters" />
                    


                            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 Oakrey.Parameters --version 1.0.0
                    


                    

                
#r "nuget: Oakrey.Parameters, 1.0.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. 
#addin nuget:?package=Oakrey.Parameters&version=1.0.0
                    


                            Install Oakrey.Parameters as a Cake Addin
                        

                    

                
#tool nuget:?package=Oakrey.Parameters&version=1.0.0
                    


                            Install Oakrey.Parameters as a Cake Tool

Oakrey.Parameters

Overview

The "Parameters" project provides a framework for defining, managing, and serializing various types of parameters. It is designed to handle parameters with different data types, constraints, and serialization requirements, making it suitable for applications requiring dynamic parameter management.

Features

Parameter Types:

  • ParameterBool, ParameterByte, ParameterDouble, ParameterEnum, ParameterInteger, ParameterString: Support for various data types.
  • ParameterNested: Handles nested parameter structures.

Serialization and Deserialization:

Parameters can be serialized to and deserialized from XML using ExportXml and ParseKeyValues.

Payload Management:

Parameters can generate and interpret payloads for data transmission or storage.

Validation and Constraints:

Supports constraints like minimum/maximum values, length, and offsets for parameters.

Dynamic Parameter Handling:

  • IParameter interface and ParameterBase class provide a flexible foundation for creating and managing parameters dynamically.

Error Handling:

  • PayloadGenerateException: Custom exception for handling payload generation errors.

Integration with XML:

Leverages XML for parameter configuration and storage.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

  1. Open your project in Visual Studio.
  2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
  3. Search for Oakrey.Parameters and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Parameters

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Parameters

Requirements

  • .NET 8 or higher

Project Information

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.

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.

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.0.0 191 4/16/2025