Utils.UriQueryHelper 1.0.0-alpha1

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

// Install Utils.UriQueryHelper as a Cake Tool
#tool nuget:?package=Utils.UriQueryHelper&version=1.0.0-alpha1&prerelease                

UriQuery

UriQuery is an unitility class that can be used to modify URI query strings. Can be uses with Uri or UriBuilder class objects to modify their Query property.

Usage

private const string BaseUri = "https://host.com:443/path";

[Test]
public void AddParameter()
{
    var target = new UriBuilder($"{BaseUri}?param1=value1");

    target.Query = UriQuery.Parse(target.Query).With("param2", "value2").GetQuery();

    Assert.That(target.ToString(), Is.EqualTo($"{BaseUri}?param1=value1&param2=value2"));
}

[Test]
public void OverrideExistingParameter()
{
    var target = new UriBuilder($"{BaseUri}?param1=value1");

    target.Query = UriQuery.Parse(target.Query).With("param1", "value2").GetQuery();

    Assert.That(target.ToString(), Is.EqualTo($"{BaseUri}?param1=value2"));
}

[Test]
public void AppendValueToParameter()
{
    var target = new UriBuilder($"{BaseUri}?param1=value1");

    target.Query = UriQuery.Parse(target.Query).Append("param1", "value2").GetQuery();

    Assert.That(target.ToString(), Is.EqualTo($"{BaseUri}?param1[]=value1&param1[]=value2"));
}

[Test]
public void RemoveParameter()
{
    var target = new UriBuilder($"{BaseUri}?param1=value1&param2=value2");

    target.Query = UriQuery.Parse(target.Query).Without("param1").GetQuery();

    Assert.That(target.ToString(), Is.EqualTo($"{BaseUri}?param2=value2"));
}

[Test]
public void RemoveValueFromMultiValuedParameter()
{
    var target = new UriBuilder($"{BaseUri}?param[]=value1&param[]=value2&param[]=value3");

    target.Query = UriQuery.Parse(target.Query).Without("param", "value2").GetQuery();

    Assert.That(target.ToString(), Is.EqualTo($"{BaseUri}?param[]=value1&param[]=value3"));
}

See UriQueryTests.cs file for other usage samples.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.
  • net7.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
1.0.0 112 1/14/2024
1.0.0-rc2 63 1/14/2024
1.0.0-alpha2 73 1/14/2024
1.0.0-alpha1 101 11/28/2023