Skip to content

Commit 8dc0ddd

Browse files
Updated README
1 parent a655e5b commit 8dc0ddd

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -377,19 +377,32 @@ With this approach, you will achieve that your property `date` is going to be a
377377

378378
### Public properties
379379

380-
#### `(number) JsonConvert.operationMode`
380+
#### Operation mode
381+
382+
`(number) JsonConvert.operationMode`
381383

382384
Determines how the JsonConvert class instance should operate.
385+
383386
You may assign three different values:
384387
- `OperationMode.DISABLE`: json2typescript will be disabled, no type checking or mapping is done
385388
- `OperationMode.ENABLE`: json2typescript is enabled, but only errors are logged
386389
- `OperationMode.LOGGING`: json2typescript is enabled and detailed information is logged
387390

388-
The default value is `OperationMode.ENABLE`.
391+
The default value is `OperationMode.ENABLE`. It will only print errors to the console and is suited for production.
392+
393+
In some cases, you might consider disabling `json2typescript` in production by setting the `OperationMode.DISABLE` flag.
394+
This only works in case you only use plain objects without functionality and no mapping.
395+
However, disabling `json2typescript` might give you a performance disadvantage in heavy projects.
396+
397+
In case you have issues to find bugs, you can enable additional logging by setting the `OperationMode.LOGGING` flag.
398+
Please note that every serializing and deserializing is heavily logged to the console and will make your application slower.
399+
Never use this flag in production.
389400

390401
> Tip: Make sure you import the `ENUM` `OperationMode` when assigning a value to this property.
391402

392-
#### `(number) JsonConvert.valueCheckingMode`
403+
#### Value checking mode
404+
405+
`(number) JsonConvert.valueCheckingMode`
393406

394407
Determines which types are allowed to be null.
395408
You may assign three different values:
@@ -401,14 +414,15 @@ The default is `ValueCheckingMode.ALLOW_OBJECT_NULL`.
401414

402415
> Tip: Make sure you import the `ENUM` `ValueCheckingMode` when assigning a value to this property.
403416

404-
#### `(bool) JsonConvert.ignorePrimitiveChecks`
417+
#### Ignore primitive checks
418+
419+
`(bool) JsonConvert.ignorePrimitiveChecks`
405420

406421
Determines whether primitive types should be checked.
407422
If true, it will be allowed to assign primitive to other primitive types.
408423

409424
The default is `false`.
410425

411-
412426
> Tip: The TypeScript developer team suggests you to avoid null values. If your JSON api doesn't return null values, you should try the last flag disallowing null values.
413427

414428
### Public methods

0 commit comments

Comments
 (0)