QuickJson 1.0.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package QuickJson --version 1.0.0

NuGet\Install-Package QuickJson -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="QuickJson" Version="1.0.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

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

paket add QuickJson --version 1.0.0

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

#r "nuget: QuickJson, 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.

// Install QuickJson as a Cake Addin
#addin nuget:?package=QuickJson&version=1.0.0

// Install QuickJson as a Cake Tool
#tool nuget:?package=QuickJson&version=1.0.0

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

QuickJson

✅ Project status: active.

QuickJson is a very basic JSON parser distributed as a source-only NuGet package, which allows it to be referenced without imposing any runtime dependencies.

Download

📦 NuGet: dotnet add package QuickJson

Usage

⚠ To use this package, your project needs to target C# 8 or later. You can ensure this by setting <LangVersion>latest</LangVersion> in the project file.

To parse a JSON string, call Json.TryParse(...) or Json.Parse(...):

// This returns null on invalid JSON
var json = Json.TryParse("{ \"foo\": [ 69, true, \"bar\" ] }");

// This throws on invalid JSON
var json = Json.Parse("{ \"foo\": [ 69, true, \"bar\" ] }");

To retrieve a nested node in the parsed JSON, use TryGetChild(...):

// May return null if the property doesn't exist
// or if the referenced node is not an object
var foo = json.TryGetChild("foo");

// May return null if the child doesn't exist
// or if the referenced node is not an array
var child1 = foo?.TryGetChild(0);
var child2 = foo?.TryGetChild(1);
var child3 = foo?.TryGetChild(2);

Alternatively, you can also enumerate all object properties using EnumerateProperties() or all array children using EnumerateChildren():

// Returns an empty enumerator if the referenced node is not an object
foreach (var prop in json.EnumerateProperties())
{
    var name = prop.Name; // string
    var value = prop.Value; // JsonNode
    
    // ...
}

// Returns an empty enumerator if the referenced node is not an array
foreach (var child in json.EnumerateChildren())
{
    // ...
}

In order to extract values from nodes, use TryGetNumber(), TryGetBool(), or TryGetString():

// May return null if the node contains a value of a different kind
var value1 = child1?.TryGetNumber(); // 69
var value2 = child2?.TryGetBool(); // true
var value3 = child3?.TryGetString(); // "bar"

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.