@dipscope/type-manager 4.0.1 → 4.0.2

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.0.2] - 2022-05-01
+
+### Changed
+
+- Used symbol instead of string based key to store type metadata.
+- Avoid complete reset of custom data by providing `null` as argument.
+- Code style improvements.
+
 ## [4.0.1] - 2021-08-01
 
 ### Changed

package/README.md

@@ -6,6 +6,10 @@ Type manager is a parsing package for `TypeScript` which will help you to transf
 
 We recommend to use our [official website](https://dipscope.com/type-manager/what-issues-it-solves) to navigate through available features. You can also use the latest documentation described below.
 
+## Give a star :star:
+
+If you like or are using this project please give it a star. Thanks!
+
 ## Table of contents
 
 * [What issues it solves?](#what-issues-it-solves)
@@ -1319,7 +1323,7 @@ It uses 2 special configurable type options:
 
 This options have default values if you have not configured them explicitly.
 
-* Default value of discriminator is a `__type__`. During deserialization `TypeManager` expects such property to be present inside a polymorphic object.
+* Default value of discriminator is a `$type`. During deserialization `TypeManager` expects such property to be present inside a polymorphic object.
 * Default value of discriminant is a `ClassName` which determined based on the type function.
 
 For proper deserialization of polymorphic types you have to provide such information inside your JSON.
@@ -1328,18 +1332,18 @@ For proper deserialization of polymorphic types you have to provide such informa
 {
     "shapes": [
         {
-            "__type__": "Rectangle",
+            "$type": "Rectangle",
             "title": "Cool rectangle",
             "width": 10,
             "height": 10
         }, 
         {
-            "__type__": "Square",
+            "$type": "Square",
             "title": "Perfect square",
             "width": 10
         },
         {
-            "__type__": "Circle",
+            "$type": "Circle",
             "title": "Simple circle",
             "radius": 6
         }
@@ -1349,7 +1353,7 @@ For proper deserialization of polymorphic types you have to provide such informa
 
 Now your JSON will be handled properly and you will get `Rectangle`, `Square` and `Circle` class instances in return.
 
-In most cases your `Discriminator` and `Discriminant` values will not match to our default ones. For example library like [Json.NET](https://www.newtonsoft.com/json) can be used on the backend side to send a response from your API. It uses `$type` property as `Discriminator` and full name of class as `Discriminant`. In such scenario our JSON may look like this.
+In some cases your `Discriminator` or `Discriminant` values will not match to our default ones. For example library like [Json.NET](https://www.newtonsoft.com/json) can be used on the backend side to send a response from your API. It uses `$type` property as `Discriminator` and full name of class as `Discriminant`. In such scenario our JSON may look like this.
 
 ```json
 {
@@ -1381,7 +1385,7 @@ import { TypeManagerOptions } from '@dipscope/type-manager';
 import { TypeOptionsBase } from '@dipscope/type-manager/core';
 
 const typeOptionsBase: TypeOptionsBase<any> = {
-    discriminator: '$type'
+    discriminator: '$customType'
 };
 
 const typeManagerOptions: TypeManagerOptions = {
@@ -1990,11 +1994,11 @@ Polymorphic types are supported. In most cases additional configuration is requi
 
 See information about breaking changes, release notes and migration steps between versions [here](https://github.com/dipscope/TypeManager.TS/blob/master/CHANGELOG.md).
 
-Thanks for checking this package. If you like it please give repo a star.
+Thanks for checking this package.
 
 Feel free to create an issue if you find any mistakes in documentation or have any improvements in mind.
 
-I wish you good luck and happy coding! ;)
+We wish you good luck and happy coding!
 
 ## License
 

package/core/fn.d.ts

@@ -51,7 +51,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is function. False otherwise.
      */
-    static isFunction(x: any): x is (...args: any[]) => any;
+    static isFunction(x: any): x is (...args: Array<any>) => any;
     /**
      * Checks if value is an arrow function.
      *
@@ -59,7 +59,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is an arrow function. False otherwise.
      */
-    static isArrowFunction(x: any): x is (...args: any[]) => any;
+    static isArrowFunction(x: any): x is (...args: Array<any>) => any;
     /**
      * Checks if value is a constructor.
      *
@@ -67,7 +67,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is a constructor. False otherwise.
      */
-    static isCtor(x: any): x is new (...args: any[]) => any;
+    static isCtor(x: any): x is new (...args: Array<any>) => any;
     /**
      * Checks if value is string.
      *
@@ -107,7 +107,7 @@ export declare class Fn {
      *
      * @returns {boolean} True when value is array. False otherwise.
      */
-    static isArray(x: any): x is any[];
+    static isArray(x: any): x is Array<any>;
     /**
      * Checks if value is date.
      *
@@ -248,7 +248,7 @@ export declare class Fn {
      * Performs deep assignment and returns target object.
      *
      * @param {Record<string, any>} target Target object.
-     * @param {Record<string, any>[]} sources Source objects.
+     * @param {Array<Record<string, any>>} sources Source objects.
      *
      * @returns {Record<string, any>} Target object.
      */
@@ -268,25 +268,25 @@ export declare class Fn {
      *
      * @param {string} x String.
      *
-     * @returns {string[]} Array with the words of provided string.
+     * @returns {Array<string>} Array with the words of provided string.
      */
-    static unicodeWords(x: string): string[];
+    static unicodeWords(x: string): Array<string>;
     /**
      * Splits a ASCII string into an array of its words.
      *
      * @param {string} x String.
      *
-     * @returns {string[]} Array with the words of provided string.
+     * @returns {Array<string>} Array with the words of provided string.
      */
-    static asciiWords(x: string): string[];
+    static asciiWords(x: string): Array<string>;
     /**
      * Splits string into an array of its words.
      *
      * @param {string} x String.
      *
-     * @returns {string[]} Array with the words of provided string.
+     * @returns {Array<string>} Array with the words of provided string.
      */
-    static words(x: string): string[];
+    static words(x: string): Array<string>;
     /**
      * Checks if reflect metadata is supported.
      *

package/core/generic-argument.d.ts

@@ -4,4 +4,4 @@ import { TypeArgument } from './type-argument';
  *
  * @type {GenericArgument<TType>}
  */
-export declare type GenericArgument<TType> = TypeArgument<TType> | [TypeArgument<TType>, GenericArgument<any>[]];
+export declare type GenericArgument<TType> = TypeArgument<TType> | [TypeArgument<TType>, Array<GenericArgument<any>>];

package/core/generic-metadata.d.ts

@@ -4,4 +4,4 @@ import { TypeMetadata } from './type-metadata';
  *
  * @type {GenericMetadata<TType>}
  */
-export declare type GenericMetadata<TType> = [TypeMetadata<TType>, GenericMetadata<any>[]];
+export declare type GenericMetadata<TType> = [TypeMetadata<TType>, Array<GenericMetadata<any>>];

package/core/index.d.ts

@@ -34,6 +34,7 @@ export * from './type-ctor';
 export * from './type-fn';
 export * from './type-like';
 export * from './type-metadata-resolver';
+export * from './type-metadata-symbol';
 export * from './type-metadata';
 export * from './type-name';
 export * from './type-options-base';