@tsed/json-mapper - npm Package Compare versions

Comparing version 6.0.0-alpha.4 to 6.0.0-alpha.5

lib/components/ArrayMapper.d.ts

 import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
 /**
- * Converter component for the `Array` Type.
+ * Mapper for `Array` type.
  * @jsonmapper
- * @converter
  * @component
@@ -7,0 +6,0 @@ */

lib/components/ArrayMapper.js

@@ -6,5 +6,4 @@ "use strict";
 /**
- * Converter component for the `Array` Type.
+ * Mapper for `Array` type.
  * @jsonmapper
- * @converter
  * @component
@@ -11,0 +10,0 @@ */

lib/components/DateMapper.d.ts

 import { JsonMapperMethods } from "../interfaces/JsonMapperMethods";
 /**
- * Converter component for the `Date` Type.
+ * Mapper for `Date` type.
  * @jsonmapper
- * @converter
  * @component
@@ -7,0 +6,0 @@ */

lib/components/DateMapper.js

@@ -6,5 +6,4 @@ "use strict";
 /**
- * Converter component for the `Date` Type.
+ * Mapper for `Date` type.
  * @jsonmapper
- * @converter
  * @component
@@ -11,0 +10,0 @@ */

lib/components/MapMapper.d.ts

 import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
 /**
- * Converter component for the `Map` Type.
+ * Mapper for `Map` type.
  * @jsonmapper
- * @converter
  * @component
@@ -7,0 +6,0 @@ */

lib/components/MapMapper.js

@@ -6,5 +6,4 @@ "use strict";
 /**
- * Converter component for the `Map` Type.
+ * Mapper for `Map` type.
  * @jsonmapper
- * @converter
  * @component
@@ -11,0 +10,0 @@ */

lib/components/PrimitiveMapper.d.ts

 import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
 /**
- * Converter component for the `String`, `Number` and `Boolean` Types.
- * @converters
+ * Mapper for the `String`, `Number` and `Boolean` types.
  * @jsonmapper
@@ -6,0 +5,0 @@ * @component

lib/components/PrimitiveMapper.js

@@ -7,4 +7,3 @@ "use strict";
 /**
- * Converter component for the `String`, `Number` and `Boolean` Types.
- * @converters
+ * Mapper for the `String`, `Number` and `Boolean` types.
  * @jsonmapper
@@ -11,0 +10,0 @@ * @component

lib/components/SetMapper.d.ts

 import { JsonMapperCtx, JsonMapperMethods } from "../interfaces/JsonMapperMethods";
 /**
- * Converter component for the `Set` Type.
- * @converters
+ * Mapper for the `Set` Type.
  * @jsonmapper
@@ -6,0 +5,0 @@ * @component

lib/components/SetMapper.js

@@ -6,4 +6,3 @@ "use strict";
 /**
- * Converter component for the `Set` Type.
- * @converters
+ * Mapper for the `Set` Type.
  * @jsonmapper
@@ -10,0 +9,0 @@ * @component

lib/components/SymbolMapper.d.ts

 import { JsonMapperMethods } from "../interfaces/JsonMapperMethods";
 /**
- * Converter component for the `Symbol` Type.
+ * Mapper for the `Symbol` type.
  *
@@ -5,0 +5,0 @@ * @jsonmapper

lib/components/SymbolMapper.js

@@ -6,3 +6,3 @@ "use strict";
 /**
- * Converter component for the `Symbol` Type.
+ * Mapper for the `Symbol` type.
  *
@@ -9,0 +9,0 @@ * @jsonmapper

package.json

 {
   "name": "@tsed/json-mapper",
-  "version": "6.0.0-alpha.4",
+  "version": "6.0.0-alpha.5",
   "description": "Json mapper module for Ts.ED Framework",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
+  "keywords": [
+    "TypeScript",
+    "decorators",
+    "models",
+    "json mapper",
+    "mapper",
+    "serialization",
+    "deserialization",
+    "class",
+    "classes",
+    "tsed"
+  ],
   "dependencies": {
-    "@tsed/core": "6.0.0-alpha.4",
+    "@tsed/core": "6.0.0-alpha.5",
     "tslib": "1.11.0"
   },
   "devDependencies": {
-    "@tsed/schema": "6.0.0-alpha.4"
+    "@tsed/schema": "6.0.0-alpha.5"
   },
@@ -14,0 +26,0 @@ "scripts": {

readme.md

@@ -1,9 +0,19 @@
-# @tsed/schema
+# @tsed/json-mapper
 
 A package of Ts.ED framework. See website: https://tsed.io/
 
-Package to declare JsonSchema and OpenAPI.
+The `@tsed/json-mapper` package is responsible to map a plain object to a model and a model to a plain object.
 
-# Installation
+It provides two functions `serialize` and `deserialize` to transform object depending on which operation you want to perform.
+It uses all decorators from `@tsed/schema` package and TypeScript metadata to work.
 
+Ts.ED use this package to transform any input parameters sent by your consumer to a class and transform returned value by your endpoint
+to a plain javascript object to your consumer.
+
+## Documentation
+
+Documentation is available on [v6.tsed.io/docs/converters.html](https://v6.tsed.io/docs/converters.html)
+
+## Installation
+
 You can get the latest release and the type definitions using npm:
@@ -10,0 +20,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

59586

increased by0.48%

Number of lines in readme file

51

increased by24.39%

Worsened metrics

Lines of code

718

decreased by-1.37%

Dependency changes

• + Added@tsed/core@6.0.0-alpha.5(transitive)

• - Removed@tsed/core@6.0.0-alpha.4(transitive)

• Updated@tsed/core@6.0.0-alpha.5