fix(api): change representation of nullable types to union with null …

…instead of optional parameter
gkinsman · Sep 25, 2018 · c31ec95 · c31ec95
1 parent 279d6fc
commit c31ec95
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -157,7 +157,7 @@ declare namespace Api {
 
 ## Nullable Value Types
 
-Nullable value types are rendered to optional properties in TypeScript:
+Nullable value types are rendered to properties with a null union in TypeScript:
 
 ```csharp
 class TypeWithNullable
@@ -170,8 +170,8 @@ class TypeWithNullable
 ```TypeScript
 declare namespace Api {
   interface TypeWithNullable {
-    nullableInt?: number;
-    nullableGuid?: string;
+    nullableInt: number | null;
+    nullableGuid: string | null;
   }
 }
 ```

diff --git a/...nums/EnumGeneratorTests.Generator_TypeWithNullableEnum_GeneratesSuccessfully.approved.txt b/...nums/EnumGeneratorTests.Generator_TypeWithNullableEnum_GeneratesSuccessfully.approved.txt
@@ -1,6 +1,6 @@
 declare namespace Api {
   interface TypeWithNullableEnum {
-    nullableEnumProp?: 'FirstEnum' | 'SecondEnum' | 'ThirdEnum';
+    nullableEnumProp: 'FirstEnum' | 'SecondEnum' | 'ThirdEnum' | null;
   }
 }
 

diff --git a/...bleTypeGeneratorTests.Generator_TypeWithNestedNullable_GeneratesSuccessfully.approved.txt b/...bleTypeGeneratorTests.Generator_TypeWithNestedNullable_GeneratesSuccessfully.approved.txt
@@ -3,7 +3,7 @@ declare namespace Api {
     nestedThing: NestedType;
   }
   interface NestedType {
-    nullableInt?: number;
+    nullableInt: number | null;
     nullableDateTime: string;
   }
 }
diff --git a/.../NullableTypeGeneratorTests.Generator_TypeWithNullable_GeneratesSuccessfully.approved.txt b/.../NullableTypeGeneratorTests.Generator_TypeWithNullable_GeneratesSuccessfully.approved.txt
@@ -1,6 +1,6 @@
 declare namespace Api {
   interface TypeWithNullable {
-    nullableInt?: number;
-    nullableGuid?: string;
+    nullableInt: number | null;
+    nullableGuid: string | null;
   }
 }
diff --git a/src/Typescriptr/TypeScriptGenerator.cs b/src/Typescriptr/TypeScriptGenerator.cs
@@ -10,8 +10,11 @@
 namespace Typescriptr
 {
     public delegate string FormatEnum(Type t, QuoteStyle quoteStyle);
+
     public delegate string FormatEnumProperty(Type t, QuoteStyle quoteStyle);
+
     public delegate string FormatDictionaryProperty(Type t, Func<Type, string> typeNameRenderer);
+
     public delegate string FormatCollectionProperty(Type t, Func<Type, string> typeNameRenderer);
 
     public class TypeScriptGenerator
@@ -55,7 +58,8 @@ private TypeScriptGenerator()
             .WithPropertyTypeFormatter<TimeSpan>(t => "string")
             .WithPropertyTypeFormatter<Guid>(t => "string")
             .WithPropertyTypeFormatter<DateTimeOffset>(t => "string")
-            .WithEnumFormatter(EnumFormatter.ValueNamedEnumFormatter, EnumFormatter.UnionStringEnumPropertyTypeFormatter)
+            .WithEnumFormatter(EnumFormatter.ValueNamedEnumFormatter,
+                EnumFormatter.UnionStringEnumPropertyTypeFormatter)
             .WithQuoteStyle(QuoteStyle.Single)
             .WithDictionaryPropertyFormatter(DictionaryPropertyFormatter.KeyValueFormatter)
             .WithCollectionPropertyFormatter(CollectionPropertyFormatter.Format)
@@ -73,13 +77,13 @@ public TypeScriptGenerator WithQuoteStyle(QuoteStyle style)
             _quoteStyle = style;
             return this;
         }
-        
+
         public TypeScriptGenerator WithNamespace(string @namespace)
         {
             _namespace = @namespace;
             return this;
         }
-        
+
         public TypeScriptGenerator WithDictionaryPropertyFormatter(FormatDictionaryProperty formatter)
         {
             _dictionaryPropertyFormatter = formatter;
@@ -142,7 +146,7 @@ public GenerationResult Generate(IEnumerable<Type> types)
             {
                 typeBuilder.AppendLine();
             }
-            
+
             return new GenerationResult(typeBuilder.ToString(), enumBuilder.ToString());
         }
 
@@ -165,8 +169,6 @@ private void RenderType(StringBuilder builder, Type type)
 
                 if (_useCamelCasePropertyNames)
                     propName = propName.ToCamelCase();
-                if (Nullable.GetUnderlyingType(propType) != null)
-                    propName = $"{propName}?";
 
                 RenderProperty(builder, propType, propName);
             }
@@ -182,25 +184,30 @@ private void RenderType(StringBuilder builder, Type type)
 
         private string TypeNameRenderer(Type type)
         {
+            Func<string, string> decorate = str => str;
+
             if (Nullable.GetUnderlyingType(type) != null)
+            {
                 type = Nullable.GetUnderlyingType(type);
+                decorate = str => str + " | null";
+            }
 
             if (_propTypeMap.ContainsKey(type))
-                return _propTypeMap[type];
-            
+                return decorate(_propTypeMap[type]);
+
             if (typeof(IDictionary).IsAssignableFrom(type))
-                return _dictionaryPropertyFormatter(type, TypeNameRenderer);
-    
+                return decorate(_dictionaryPropertyFormatter(type, TypeNameRenderer));
+
             if (typeof(IEnumerable).IsAssignableFrom(type))
-                return _collectionPropertyFormatter(type, TypeNameRenderer);
+                return decorate(_collectionPropertyFormatter(type, TypeNameRenderer));
 
             var typeName = type.Name;
             if (typeof(Enum).IsAssignableFrom(type))
                 typeName = _enumPropertyFormatter(type, _quoteStyle);
 
             if (!_typesGenerated.Contains(type)) _typeStack.Push(type);
-            
-            return typeName;
+
+            return decorate(typeName);
         }
 
         private void RenderProperty(StringBuilder builder, Type propType, string propName)