add union support (#45) +semver: minor

Author: charlesdevandiere

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "xmldoc2markdown": {
-      "version": "4.0.0",
+      "version": "5.0.0",
       "commands": [
         "xmldoc2md"
       ]

docs/api/graphql.query.builder.iquery-1.md

@@ -16,7 +16,8 @@ public interface IQuery<TSource> : IQuery
 
 `TSource`<br>
 
-Implements [IQuery](./graphql.query.builder.iquery)
+Implements [IQuery](./graphql.query.builder.iquery)<br>
+Attributes [NullableContextAttribute](./system.runtime.compilerservices.nullablecontextattribute)
 
 ## Properties
 
@@ -183,6 +184,55 @@ The sub-object query building function.
 [IQuery&lt;TSource&gt;](./graphql.query.builder.iquery-1)<br>
 The query.
 
+### **AddUnion&lt;TUnionType&gt;(String, Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;)**
+
+Adds an union to the query.
+
+```csharp
+IQuery<TSource> AddUnion<TUnionType>(string typeName, Func<IQuery<TUnionType>, IQuery<TUnionType>> build)
+```
+
+#### Type Parameters
+
+`TUnionType`<br>
+The union type.
+
+#### Parameters
+
+`typeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
+The union type name.
+
+`build` Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;<br>
+The union building function.
+
+#### Returns
+
+[IQuery&lt;TSource&gt;](./graphql.query.builder.iquery-1)<br>
+The query.
+
+### **AddUnion&lt;TUnionType&gt;(Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;)**
+
+Adds an union to the query.
+
+```csharp
+IQuery<TSource> AddUnion<TUnionType>(Func<IQuery<TUnionType>, IQuery<TUnionType>> build)
+```
+
+#### Type Parameters
+
+`TUnionType`<br>
+The union type.
+
+#### Parameters
+
+`build` Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;<br>
+The union building function.
+
+#### Returns
+
+[IQuery&lt;TSource&gt;](./graphql.query.builder.iquery-1)<br>
+The query.
+
 ### **AddArgument(String, Object)**
 
 Adds a new argument to the query.

docs/api/graphql.query.builder.iquery.md

@@ -12,6 +12,8 @@ The query interface.
 public interface IQuery
 ```
 
+Attributes [NullableContextAttribute](./system.runtime.compilerservices.nullablecontextattribute)
+
 ## Properties
 
 ### **Name**

docs/api/graphql.query.builder.iquerystringbuilder.md

@@ -12,6 +12,8 @@ The GraphQL query builder interface.
 public interface IQueryStringBuilder
 ```
 
+Attributes [NullableContextAttribute](./system.runtime.compilerservices.nullablecontextattribute)
+
 ## Methods
 
 ### **Clear()**

docs/api/graphql.query.builder.query-1.md

@@ -17,7 +17,18 @@ public class Query<TSource> : IQuery`1, IQuery
 `TSource`<br>
 
 Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Query&lt;TSource&gt;](./graphql.query.builder.query-1)<br>
-Implements IQuery&lt;TSource&gt;, [IQuery](./graphql.query.builder.iquery)
+Implements IQuery&lt;TSource&gt;, [IQuery](./graphql.query.builder.iquery)<br>
+Attributes [NullableContextAttribute](./system.runtime.compilerservices.nullablecontextattribute), [NullableAttribute](./system.runtime.compilerservices.nullableattribute)
+
+## Fields
+
+### **options**
+
+The query options.
+
+```csharp
+protected QueryOptions options;
+```
 
 ## Properties
 
@@ -69,6 +80,18 @@ public string AliasName { get; private set; }
 
 [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
 
+### **QueryStringBuilder**
+
+Gets the query string builder.
+
+```csharp
+protected IQueryStringBuilder QueryStringBuilder { get; }
+```
+
+#### Property Value
+
+[IQueryStringBuilder](./graphql.query.builder.iquerystringbuilder)<br>
+
 ## Constructors
 
 ### **Query(String)**
@@ -236,6 +259,55 @@ The sub-object query building function.
 IQuery&lt;TSource&gt;<br>
 The query.
 
+### **AddUnion&lt;TUnionType&gt;(String, Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;)**
+
+Adds an union to the query.
+
+```csharp
+public IQuery<TSource> AddUnion<TUnionType>(string typeName, Func<IQuery<TUnionType>, IQuery<TUnionType>> build)
+```
+
+#### Type Parameters
+
+`TUnionType`<br>
+The union type.
+
+#### Parameters
+
+`typeName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
+The union type name.
+
+`build` Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;<br>
+The union building function.
+
+#### Returns
+
+IQuery&lt;TSource&gt;<br>
+The query.
+
+### **AddUnion&lt;TUnionType&gt;(Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;)**
+
+Adds an union to the query.
+
+```csharp
+public IQuery<TSource> AddUnion<TUnionType>(Func<IQuery<TUnionType>, IQuery<TUnionType>> build)
+```
+
+#### Type Parameters
+
+`TUnionType`<br>
+The union type.
+
+#### Parameters
+
+`build` Func&lt;IQuery&lt;TUnionType&gt;, IQuery&lt;TUnionType&gt;&gt;<br>
+The union building function.
+
+#### Returns
+
+IQuery&lt;TSource&gt;<br>
+The query.
+
 ### **AddArgument(String, Object)**
 
 Adds a new argument to the query.

docs/api/graphql.query.builder.queryformatters.md

@@ -13,7 +13,18 @@ public class QueryStringBuilder : IQueryStringBuilder
 ```
 
 Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [QueryStringBuilder](./graphql.query.builder.querystringbuilder)<br>
-Implements [IQueryStringBuilder](./graphql.query.builder.iquerystringbuilder)
+Implements [IQueryStringBuilder](./graphql.query.builder.iquerystringbuilder)<br>
+Attributes [NullableContextAttribute](./system.runtime.compilerservices.nullablecontextattribute), [NullableAttribute](./system.runtime.compilerservices.nullableattribute)
+
+## Fields
+
+### **formatter**
+
+The property name formatter.
+
+```csharp
+protected Func<PropertyInfo, string> formatter;
+```
 
 ## Properties
 
@@ -54,6 +65,28 @@ The property name formatter
 
 ## Methods
 
+### **Build&lt;TSource&gt;(IQuery&lt;TSource&gt;)**
+
+Builds the query.
+
+```csharp
+public string Build<TSource>(IQuery<TSource> query)
+```
+
+#### Type Parameters
+
+`TSource`<br>
+
+#### Parameters
+
+`query` IQuery&lt;TSource&gt;<br>
+The query.
+
+#### Returns
+
+[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
+The GraphQL query as string, without outer enclosing block.
+
 ### **Clear()**
 
 Clears the string builder.
@@ -97,24 +130,6 @@ The formatted query param.
 [InvalidDataException](https://docs.microsoft.com/en-us/dotnet/api/system.io.invaliddataexception)<br>
 Invalid Object Type in Param List
 
-### **ObjectToDictionary(Object)**
-
-Convert object into dictionary.
-
-```csharp
-internal Dictionary<string, object> ObjectToDictionary(object object)
-```
-
-#### Parameters
-
-`object` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)<br>
-The object.
-
-#### Returns
-
-[Dictionary&lt;String, Object&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.dictionary-2)<br>
-The object as dictionary.
-
 ### **AddParams&lt;TSource&gt;(IQuery&lt;TSource&gt;)**
 
 Adds query params to the query string.
@@ -154,28 +169,6 @@ The query.
 [ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/system.argumentexception)<br>
 Invalid Object in Field List
 
-### **Build&lt;TSource&gt;(IQuery&lt;TSource&gt;)**
-
-Builds the query.
-
-```csharp
-public string Build<TSource>(IQuery<TSource> query)
-```
-
-#### Type Parameters
-
-`TSource`<br>
-
-#### Parameters
-
-`query` IQuery&lt;TSource&gt;<br>
-The query.
-
-#### Returns
-
-[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
-The GraphQL query as string, without outer enclosing block.
-
 ---
 
 [`< Back`](./)

docs/api/graphql.query.builder.querystringbuilder.md

@@ -1,4 +1,4 @@
 @echo off
 dotnet tool restore
-dotnet build .\src\GraphQL.Query.Builder\GraphQL.Query.Builder.csproj -c Release -o out\
-dotnet tool run xmldoc2md .\out\GraphQL.Query.Builder.dll .\docs\api --github-pages --back-button
+dotnet build ./src/GraphQL.Query.Builder/GraphQL.Query.Builder.csproj -c Release -o out/
+dotnet xmldoc2md out/GraphQL.Query.Builder.dll --output ./docs/api --github-pages --back-button

generate-documentation.bat

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+rm -rf ./out/
+find ./docs/api -name "*.md" -type f -delete
+
 dotnet tool restore
-dotnet build src/GraphQL.Query.Builder/GraphQL.Query.Builder.csproj -c Release -o out/
-dotnet tool run xmldoc2md out/GraphQL.Query.Builder.dll docs/api --github-pages --back-button
+dotnet build ./src/GraphQL.Query.Builder/GraphQL.Query.Builder.csproj -c Release -o out/
+dotnet xmldoc2md out/GraphQL.Query.Builder.dll --output ./docs/api --github-pages --back-button

generate-documentation.sh

@@ -57,6 +57,24 @@ IQuery<TSource> AddField<TSubSource>(
         Func<IQuery<TSubSource>, IQuery<TSubSource>> build)
         where TSubSource : class?;
 
+    /// <summary>Adds an union to the query.</summary>
+    /// <typeparam name="TUnionType">The union type.</typeparam>
+    /// <param name="typeName">The union type name.</param>
+    /// <param name="build">The union building function.</param>
+    /// <returns>The query.</returns>
+    IQuery<TSource> AddUnion<TUnionType>(
+        string typeName,
+        Func<IQuery<TUnionType>, IQuery<TUnionType>> build)
+        where TUnionType : class?, TSource;
+
+    /// <summary>Adds an union to the query.</summary>
+    /// <typeparam name="TUnionType">The union type.</typeparam>
+    /// <param name="build">The union building function.</param>
+    /// <returns>The query.</returns>
+    IQuery<TSource> AddUnion<TUnionType>(
+        Func<IQuery<TUnionType>, IQuery<TUnionType>> build)
+        where TUnionType : class?, TSource;
+
     /// <summary>Adds a new argument to the query.</summary>
     /// <param name="key">The argument name.</param>
     /// <param name="value">The value.</param>