Fixed wrong comments, updated documentation

Author: andreas-aeschlimann

CHANGELOG.md

@@ -1,3 +1,14 @@
+# v1.2.0 (2019-02-21)
+
+## Features
+
+* Allow optional properties to be null, closes [#58](https://github.com/dhlab-basel/json2typescript/issues/58)
+
+## Breaking Changes
+
+* If a property is declared optional (by `@JsonProperty(name, Type, true)`), then `null` is now ignored in both serialization and deserialization. 
+Before this version, `json2typescript` would have thrown an error if `ValueChecking.DISABLE_NULL` was used.
+
 # v1.1.1 (2019-02-12)
 
 ## Features

README.md

@@ -32,7 +32,12 @@ Make sure you catch the errors in production!
 
 See the changelog in the seperate file for bug fixes, new features and breaking changes: [Changelog](CHANGELOG.md)
 
-> Tip: At version 1.1.0 we introduced some soft breaking changes. 
+> Tip: At version 1.2.0 we introduced one more soft breaking change.
+`null` values will now be ignored when you serialize or deserialize optional values.
+This means that you are now able to use `ValueCheckingMode.DISALLOW_NULL` even when your API returns null values in the JSON.
+In that case, you should mark them optional.
+
+> Tip: At version 1.1.0 we introduced some soft breaking change. 
 `undefined` is an invalid value now for serializing or deserializing. 
 If you are working with TypeScript, you might receive some type issues after the update to v1.1.0.
 This is due to the addition of generics; they now help the compiler to detect invalid return types in the serialize and deserialize methods.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json2typescript",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Provides TypeScript methods to map a JSON object to a JavaScript object on runtime",
   "keywords": [
     "convert",

src/json2typescript/json-convert-decorators.ts

@@ -6,7 +6,7 @@ import { Any } from "./any";
  *
  * @param target the class
  */
-export function JsonConverter(target: any) {
+export function JsonConverter(target: any): void {
     target[Settings.MAPPER_PROPERTY] = "";
 }
 
@@ -15,7 +15,7 @@ export function JsonConverter(target: any) {
  *
  * @param target the class identifier or the class
  *
- * @returns {any}
+ * @returns
  *
  * @throws Error
  */
@@ -94,11 +94,11 @@ export function JsonObject(target?: string | any): any {
  * @param conversionOption optional param (default: Any), should be either the expected type (String|Boolean|Number|etc) or a custom converter class implementing JsonCustomConvert
  * @param isOptional optional param (default: false), if true, the json property does not have to be present in the object
  *
- * @returns {(target:any, classPropertyName:string)=>void}
+ * @returns
  *
  * @throws Error
  */
-export function JsonProperty(...params: any[]): any {
+export function JsonProperty(...params: any[]): { (target: any, classPropertyName: string): void } {
 
     return function (target: any, classPropertyName: string): void {
         // target is the class