Skip to content

Commit f2e7011

Browse files
Improved documentation
1 parent efc4a87 commit f2e7011

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# v1.1.1 (2019-02-12)
2+
3+
## Features
4+
5+
* Improved documentation for v1.1.0
6+
17
# v1.1.0 (2019-02-12)
28

39
## Bug Fixes

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,14 @@ Make sure you catch the errors in production!
3030

3131
See the changelog in the seperate file for bug fixes, new features and breaking changes: [Changelog](CHANGELOG.md)
3232

33+
> Tip: At version 1.1.0 we introduced some soft breaking changes.
34+
`undefined` is an invalid value now for serializing or deserializing.
35+
If you are working with TypeScript, you might receive some type issues after the update to v1.1.0.
36+
This is due to the addition of generics; they now help the compiler to detect invalid return types in the serialize and deserialize methods.
37+
3338
> Tip: Starting from version 1.0.6, we recommend to use unique class identifiers in the `@JsonObject` decorator.
3439
Read below how to use the decorators properly.
3540

36-
> Tip: Version 1.0.0 has several breaking changes. When upgrading from `json2typescript` < 1.0.0, please make sure you fix these issues.
37-
3841
---
3942

4043
# Getting started

0 commit comments

Comments
 (0)