ts-serializable 4.0.0 → 4.2.0

package/README.md

@@ -1,14 +1,14 @@
 Serializable
 =====
 
-Small library for deserialization and serialization for javascript and typescript
+Small library for deserialization and serialization for JavaScript and TypeScript
 
 Description
 ------
 
-- For working this library needed Metadata Reflection API. If your platform (browser/nodejs) don't support it you must use polifyll. Example: [reflect-metadata](https://www.npmjs.com/package/reflect-metadata)
+- For working, this library needs the Metadata Reflection API. If your platform (browser/Node.js) doesn't support it, you must use a polyfill. Example: [reflect-metadata](https://www.npmjs.com/package/reflect-metadata)
 
-- By default library don't crash on wrong types in json and return default value on wrong property. If you need more secure behavior you must override method `onWrongType` on `Serializable` object and drop exception in this method, by your logic want.
+- By default, the library doesn't crash on wrong types in JSON and returns the default value on the wrong property. If you need more secure behavior, you must override the method `onWrongType` on the `Serializable` object and throw an exception in this method, according to your logic.
 
 Installation
 ------
@@ -22,36 +22,36 @@ npm install ts-serializable
 Usage
 ------
 
-This example writed on typescript, but if remove typing, then him will work and on javascript.
+This example is written in TypeScript, but if you remove typing, it will also work in JavaScript.
 
 ```typescript
 import { jsonProperty, Serializable } from "ts-serializable";
 
 export class User extends Serializable {
 
-    // @jsonProperty parrameters is accepted types for json
-    // properties, if property in json will not by found or
-    // will have invalid type, then will return default value
+    // @jsonProperty parameters are accepted types for JSON
+    // properties. If a property in JSON is not found or
+    // has an invalid type, it will return the default value.
     @jsonProperty(Number, null)
-    public id: number | null = null; // default value necessarily
+    public id: number | null = null; // default value is necessary
 
     @jsonProperty(String)
-    public firstName: string = ''; // default value necessarily
+    public firstName: string = ''; // default value is necessary
 
     @jsonProperty(String)
-    public familyName: string = ''; // default value necessarily
+    public familyName: string = ''; // default value is necessary
 
     @jsonProperty(String, void 0)
-    public lastName?: string = void 0; // default value necessarily
+    public lastName?: string = void 0; // default value is necessary
 
     @jsonProperty(Date)
-    public birthdate: Date = new Date(); // default value necessarily
+    public birthdate: Date = new Date(); // default value is necessary
 
     @jsonProperty([String])
-    public tags: string[] = []; // default value necessarily
+    public tags: string[] = []; // default value is necessary
 
     @jsonProperty(OtherClassConstructor, null)
-    public other: OtherClassConstructor | null = null; // default value necessarily
+    public other: OtherClassConstructor | null = null; // default value is necessary
 
     public getFullName(): string {
         return [
@@ -79,19 +79,19 @@ user.getAge();
 * With Serializable
 */
 const user: User = new User().fromJSON(json);
-user.getFullName(); // work fine and return string
-user.getAge(); // work fine and return number
+user.getFullName(); // works fine and returns a string
+user.getAge(); // works fine and returns a number
 
 // or
 const user: User = User.fromJSON(json);
-user.getFullName(); // work fine and return string
-user.getAge(); // work fine and return number
+user.getFullName(); // works fine and returns a string
+user.getAge(); // works fine and returns a number
 ```
 
 Naming strategies
 ------
 
-Supported conversion between different naming cases, such as SnakeCase, KebabCase, PascalCase and CamelCase. Also you can set custom name for property of json object.
+Supported conversion between different naming cases, such as SnakeCase, KebabCase, PascalCase and CamelCase. Also, you can set a custom name for a property of a JSON object.
 
 ```typescript
 const json = {
@@ -157,7 +157,7 @@ Supported settings:
 View-Models from Backend Models
 ------
 
-If you need to create view-model from dto or entities model you can use same model. Just add VM property to dto or entities model and mark this property by @jsonIgnore() decorator and this property will not be serialized to json.
+If you need to create a view-model from a DTO or entities model, you can use the same model. Just add a VM property to the DTO or entities model and mark this property with the @jsonIgnore() decorator, and this property will not be serialized to JSON.
 
 ```typescript
 import { jsonProperty, jsonIgnore, Serializable } from "ts-serializable";
@@ -165,10 +165,10 @@ import { jsonProperty, jsonIgnore, Serializable } from "ts-serializable";
 export class User extends Serializable {
 
     @jsonProperty(String)
-    public firstName: string = ''; // default value necessarily
+    public firstName: string = ''; // default value is necessary
 
     @jsonProperty(String)
-    public familyName: string = ''; // default value necessarily
+    public familyName: string = ''; // default value is necessary
 
     @jsonIgnore()
     public isExpanded: boolean  = false;
@@ -184,7 +184,7 @@ JSON.stringify(user);
 Class to FormData
 ------
 
-Sometimes classes contain properties with the File type. Sending such classes via json is a heavy task. Converting a file property to json can freeze the interface for a few seconds if the file is large. A much better solution is to send an Ajax form. Example:
+Sometimes classes contain properties with the File type. Sending such classes via JSON is a heavy task. Converting a file property to JSON can freeze the interface for a few seconds if the file is large. A much better solution is to send an Ajax form. Example:
 
 ```typescript
 import { Serializable } from "ts-serializable";

package/dist/classes/Serializable.d.ts

@@ -1,14 +1,14 @@
 import type { AcceptedTypes } from "../models/AcceptedType.js";
 import { SerializationSettings } from "../models/SerializationSettings.js";
 /**
- * Class how help you deserialize object to classes.
+ * Class that helps you deserialize objects to classes.
  *
  * @export
  * @class Serializable
  */
 export declare class Serializable {
     /**
-     * Global setting for serialization and deserialization
+     * Global settings for serialization and deserialization.
      *
      * @static
      * @type {SerializationSettings}
@@ -16,7 +16,7 @@ export declare class Serializable {
      */
     static defaultSettings: SerializationSettings;
     /**
-     * Deserialize object from static method.
+     * Deserialize an object using a static method.
      *
      * Example:
      * const obj: MyObject = MyObject.fromJSON({...data});
@@ -28,22 +28,22 @@ export declare class Serializable {
      */
     static fromJSON<T extends Serializable>(this: new () => T, json: object, settings?: Partial<SerializationSettings>): T;
     /**
-     * Deserialize object from static method.
+     * Deserialize an object from a string using a static method.
      *
      * Example:
-     * const obj: MyObject = MyObject.fromString({...data});
+     * const obj: MyObject = MyObject.fromString("{...data}");
      *
      * @static
-     * @param {object} json
+     * @param {string} str
      * @returns {object}
      * @memberof Serializable
      */
     static fromString<T extends Serializable>(this: new () => T, str: string, settings?: Partial<SerializationSettings>): T;
     /**
-     * Fill property of current model by data from string.
+     * Fill properties of the current model with data from a string.
      *
      * Example:
-     * const obj: MyObject = new MyObject().fromString("{...data}"");
+     * const obj: MyObject = new MyObject().fromString("{...data}");
      *
      * @param {string} str
      * @returns {this}
@@ -51,7 +51,7 @@ export declare class Serializable {
      */
     fromString(str: string, settings?: Partial<SerializationSettings>): this;
     /**
-     * Fill property of current model by data from json.
+     * Fill properties of the current model with data from JSON.
      *
      * Example:
      * const obj: MyObject = new MyObject().fromJSON({...data});
@@ -62,36 +62,36 @@ export declare class Serializable {
      */
     fromJSON(json: object, settings?: Partial<SerializationSettings>): this;
     /**
-     * Process serialization for @jsonIgnore decorator
+     * Process serialization for the @jsonIgnore decorator.
      *
      * @returns {object}
      * @memberof Serializable
      */
     toJSON(): Record<string, unknown>;
     /**
-     * Serialize class to FormData.
+     * Serialize the class to FormData.
      *
-     * Can be used for prepare ajax form with files.
-     * Send files via ajax json its heavy task, because need convert file to base 64 format,
-     * user interface can be freeze on many seconds on this operation if file is too big.
-     * Ajax forms its lightweight alternative.
+     * Can be used to prepare an AJAX form with files.
+     * Sending files via AJAX JSON is a heavy task because it requires converting files to base64 format.
+     * The user interface can freeze for several seconds during this operation if the file is too large.
+     * AJAX forms are a lightweight alternative.
      *
      * @param {string} formPrefix Prefix for form property names
-     * @param {FormData} formData Can be update an existing FormData
+     * @param {FormData} formData Can update an existing FormData
      * @returns {FormData}
      * @memberof Serializable
      */
     toFormData(formPrefix?: string, formData?: FormData): FormData;
     /**
-     * Process serialization for @jsonIgnore decorator
+     * Process serialization for the @jsonIgnore decorator.
      *
      * @returns {string}
      * @memberof Serializable
      */
     toString(): string;
     /**
-     * Process exceptions from wrong types.
-     * By default just print warning in console, but can by override for drop exception or logging to backend.
+     * Process exceptions for incorrect types.
+     * By default, it just prints a warning in the console, but it can be overridden to throw exceptions or log to the backend.
      *
      * @protected
      * @param {string} prop
@@ -101,7 +101,7 @@ export declare class Serializable {
      */
     protected onWrongType(prop: string, message: string, jsonValue: unknown): void;
     /**
-     * Deserialize one property
+     * Deserialize one property.
      *
      * @private
      * @param {object} object
@@ -113,10 +113,10 @@ export declare class Serializable {
      */
     protected deserializeProperty(prop: string, acceptedTypes: AcceptedTypes[], jsonValue: unknown, settings?: Partial<SerializationSettings>): unknown;
     /**
-     * Extract correct name for property.
+     * Extract the correct name for a property.
      * Considers decorators for transforming the property name.
      *
-     * @param {string} property Source name of property
+     * @param {string} property Source name of the property
      * @param {Partial<SerializationSettings>} settings Serialization settings
      * @returns
      */

package/dist/classes/Serializable.js

@@ -9,14 +9,14 @@ import { SerializationSettings } from "../models/SerializationSettings.js";
 import { classToFormData } from "../utils/ClassToFormData.js";
 import { getPropertyName } from "../utils/GetProperyName.js";
 /**
- * Class how help you deserialize object to classes.
+ * Class that helps you deserialize objects to classes.
  *
  * @export
  * @class Serializable
  */
 export class Serializable {
     /**
-     * Global setting for serialization and deserialization
+     * Global settings for serialization and deserialization.
      *
      * @static
      * @type {SerializationSettings}
@@ -24,7 +24,7 @@ export class Serializable {
      */
     static defaultSettings = new SerializationSettings();
     /**
-     * Deserialize object from static method.
+     * Deserialize an object using a static method.
      *
      * Example:
      * const obj: MyObject = MyObject.fromJSON({...data});
@@ -38,13 +38,13 @@ export class Serializable {
         return new this().fromJSON(json, settings);
     }
     /**
-     * Deserialize object from static method.
+     * Deserialize an object from a string using a static method.
      *
      * Example:
-     * const obj: MyObject = MyObject.fromString({...data});
+     * const obj: MyObject = MyObject.fromString("{...data}");
      *
      * @static
-     * @param {object} json
+     * @param {string} str
      * @returns {object}
      * @memberof Serializable
      */
@@ -52,10 +52,10 @@ export class Serializable {
         return new this().fromJSON(JSON.parse(str), settings);
     }
     /**
-     * Fill property of current model by data from string.
+     * Fill properties of the current model with data from a string.
      *
      * Example:
-     * const obj: MyObject = new MyObject().fromString("{...data}"");
+     * const obj: MyObject = new MyObject().fromString("{...data}");
      *
      * @param {string} str
      * @returns {this}
@@ -65,7 +65,7 @@ export class Serializable {
         return this.fromJSON(JSON.parse(str), settings);
     }
     /**
-     * Fill property of current model by data from json.
+     * Fill properties of the current model with data from JSON.
      *
      * Example:
      * const obj: MyObject = new MyObject().fromJSON({...data});
@@ -79,7 +79,7 @@ export class Serializable {
         if (unknownJson === null ||
             Array.isArray(unknownJson) ||
             typeof unknownJson !== "object") {
-            this.onWrongType(String(unknownJson), "is not object", unknownJson);
+            this.onWrongType(String(unknownJson), "is not an object", unknownJson);
             return this;
         }
         // eslint-disable-next-line guard-for-in
@@ -102,7 +102,7 @@ export class Serializable {
         return this;
     }
     /**
-     * Process serialization for @jsonIgnore decorator
+     * Process serialization for the @jsonIgnore decorator.
      *
      * @returns {object}
      * @memberof Serializable
@@ -125,15 +125,15 @@ export class Serializable {
         return toJson;
     }
     /**
-     * Serialize class to FormData.
+     * Serialize the class to FormData.
      *
-     * Can be used for prepare ajax form with files.
-     * Send files via ajax json its heavy task, because need convert file to base 64 format,
-     * user interface can be freeze on many seconds on this operation if file is too big.
-     * Ajax forms its lightweight alternative.
+     * Can be used to prepare an AJAX form with files.
+     * Sending files via AJAX JSON is a heavy task because it requires converting files to base64 format.
+     * The user interface can freeze for several seconds during this operation if the file is too large.
+     * AJAX forms are a lightweight alternative.
      *
      * @param {string} formPrefix Prefix for form property names
-     * @param {FormData} formData Can be update an existing FormData
+     * @param {FormData} formData Can update an existing FormData
      * @returns {FormData}
      * @memberof Serializable
      */
@@ -141,7 +141,7 @@ export class Serializable {
         return classToFormData(this, formPrefix, formData);
     }
     /**
-     * Process serialization for @jsonIgnore decorator
+     * Process serialization for the @jsonIgnore decorator.
      *
      * @returns {string}
      * @memberof Serializable
@@ -150,8 +150,8 @@ export class Serializable {
         return JSON.stringify(this.toJSON());
     }
     /**
-     * Process exceptions from wrong types.
-     * By default just print warning in console, but can by override for drop exception or logging to backend.
+     * Process exceptions for incorrect types.
+     * By default, it just prints a warning in the console, but it can be overridden to throw exceptions or log to the backend.
      *
      * @protected
      * @param {string} prop
@@ -164,7 +164,7 @@ export class Serializable {
         console.error(`${this.constructor.name}.fromJSON: json.${prop} ${message}:`, jsonValue);
     }
     /**
-     * Deserialize one property
+     * Deserialize one property.
      *
      * @private
      * @param {object} object
@@ -182,7 +182,7 @@ export class Serializable {
                 jsonValue === null) {
                 return null;
             }
-            else if ( // Void, for deep copy classes only, json don't have void type
+            else if ( // Void, for deep copy classes only, JSON doesn't have a void type
             acceptedType === void 0 &&
                 jsonValue === void 0) {
                 return void 0;
@@ -222,7 +222,7 @@ export class Serializable {
                     unicodeTime = jsonValue.getTime();
                 }
                 if (isNaN(unicodeTime)) { // Preserve invalid time
-                    this.onWrongType(prop, "is invalid date", jsonValue);
+                    this.onWrongType(prop, "is an invalid date", jsonValue);
                 }
                 return new Date(unicodeTime);
             }
@@ -246,21 +246,21 @@ export class Serializable {
                 const TypeConstructor = acceptedType;
                 return new TypeConstructor().fromJSON(jsonValue, settings);
             }
-            else if ( // Instance any other class, not Serializable, for parse from other classes instance
+            else if ( // Instance any other class, not Serializable, for parsing from other class instances
             acceptedType instanceof Function &&
                 jsonValue instanceof acceptedType) {
                 return jsonValue;
             }
         }
-        // Process wrong type and return default value
+        // Process incorrect type and return default value
         this.onWrongType(prop, "is invalid", jsonValue);
         return Reflect.get(this, prop);
     }
     /**
-     * Extract correct name for property.
+     * Extract the correct name for a property.
      * Considers decorators for transforming the property name.
      *
-     * @param {string} property Source name of property
+     * @param {string} property Source name of the property
      * @param {Partial<SerializationSettings>} settings Serialization settings
      * @returns
      */

package/dist/decorators/JsonIgnore.d.ts

@@ -1 +1,4 @@
+/**
+ * Decorator to mark a property to be ignored during serialization.
+ */
 export declare const jsonIgnore: () => PropertyDecorator;

package/dist/decorators/JsonIgnore.js

@@ -1,3 +1,6 @@
+/**
+ * Decorator to mark a property to be ignored during serialization.
+ */
 export const jsonIgnore = () => (target, propertyKey) => {
     Reflect.defineMetadata("ts-serializable:jsonIgnore", true, target, propertyKey);
 };

package/dist/decorators/JsonName.d.ts

@@ -1 +1,6 @@
+/**
+ * Decorator to specify a custom JSON property name for a class property.
+ *
+ * @param {string} jsonPropertyName - The custom JSON property name.
+ */
 export declare const jsonName: (jsonPropertyName: string) => PropertyDecorator;

package/dist/decorators/JsonName.js

@@ -1,3 +1,8 @@
+/**
+ * Decorator to specify a custom JSON property name for a class property.
+ *
+ * @param {string} jsonPropertyName - The custom JSON property name.
+ */
 export const jsonName = (jsonPropertyName) => (target, propertyKey) => {
     Reflect.defineMetadata("ts-serializable:jsonName", jsonPropertyName, target, propertyKey);
 };

package/dist/decorators/JsonObject.d.ts

@@ -1,2 +1,7 @@
 import type { SerializationSettings } from "../models/SerializationSettings.js";
+/**
+ * Decorator to mark a class as serializable to JSON.
+ *
+ * @param {Partial<SerializationSettings>} [settings] - Optional serialization settings.
+ */
 export declare const jsonObject: (settings?: Partial<SerializationSettings>) => ClassDecorator;

package/dist/decorators/JsonObject.js

@@ -1,3 +1,8 @@
+/**
+ * Decorator to mark a class as serializable to JSON.
+ *
+ * @param {Partial<SerializationSettings>} [settings] - Optional serialization settings.
+ */
 export const jsonObject = (settings) => (target) => {
     if (settings) {
         Reflect.defineMetadata("ts-serializable:jsonObject", settings, target);

package/dist/decorators/JsonProperty.d.ts

@@ -1,2 +1,7 @@
 import type { AcceptedTypes } from "./../models/AcceptedType.js";
+/**
+ * Decorator to specify the accepted types for a JSON property.
+ *
+ * @param {...AcceptedTypes[]} args - The accepted types for the property.
+ */
 export declare const jsonProperty: (...args: AcceptedTypes[]) => PropertyDecorator;

package/dist/decorators/JsonProperty.js

@@ -1,3 +1,8 @@
+/**
+ * Decorator to specify the accepted types for a JSON property.
+ *
+ * @param {...AcceptedTypes[]} args - The accepted types for the property.
+ */
 export const jsonProperty = (...args) => (target, propertyKey) => {
     Reflect.defineMetadata("ts-serializable:jsonTypes", args, target, propertyKey);
 };

package/dist/enums/DateFormatHandling.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling date formats during serialization.
+ */
 export declare enum DateFormatHandling {
     IsoDateFormat = 0,
     MicrosoftDateFormat = 1

package/dist/enums/DateFormatHandling.js

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling date formats during serialization.
+ */
 export var DateFormatHandling;
 (function (DateFormatHandling) {
     DateFormatHandling[DateFormatHandling["IsoDateFormat"] = 0] = "IsoDateFormat";

package/dist/enums/DefaultValueHandling.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling default values during serialization.
+ */
 export declare enum DefaultValueHandling {
     Include = 0,
     Ignore = 1,// Not supported yet

package/dist/enums/DefaultValueHandling.js

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling default values during serialization.
+ */
 export var DefaultValueHandling;
 (function (DefaultValueHandling) {
     DefaultValueHandling[DefaultValueHandling["Include"] = 0] = "Include";

package/dist/enums/LogLevels.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Enum for defining log levels.
+ */
 export declare enum LogLevels {
     Trace = 0,
     Debug = 1,

package/dist/enums/LogLevels.js

@@ -1,3 +1,6 @@
+/**
+ * Enum for defining log levels.
+ */
 export var LogLevels;
 (function (LogLevels) {
     LogLevels[LogLevels["Trace"] = 0] = "Trace";

package/dist/enums/MissingMemberHandling.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling missing members during deserialization.
+ */
 export declare enum MissingMemberHandling {
     Ignore = 0,
     Error = 1

package/dist/enums/MissingMemberHandling.js

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling missing members during deserialization.
+ */
 export var MissingMemberHandling;
 (function (MissingMemberHandling) {
     MissingMemberHandling[MissingMemberHandling["Ignore"] = 0] = "Ignore";

package/dist/enums/NullValueHandling.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling null values during serialization.
+ */
 export declare enum NullValueHandling {
     Include = 0,
     Ignore = 1

package/dist/enums/NullValueHandling.js

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling null values during serialization.
+ */
 export var NullValueHandling;
 (function (NullValueHandling) {
     NullValueHandling[NullValueHandling["Include"] = 0] = "Include";

package/dist/enums/ReferenceLoopHandling.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling reference loops during serialization.
+ */
 export declare enum ReferenceLoopHandling {
     Error = 0,
     Ignore = 1,

package/dist/enums/ReferenceLoopHandling.js

@@ -1,3 +1,6 @@
+/**
+ * Enum for handling reference loops during serialization.
+ */
 export var ReferenceLoopHandling;
 (function (ReferenceLoopHandling) {
     ReferenceLoopHandling[ReferenceLoopHandling["Error"] = 0] = "Error";

package/dist/index.js

@@ -1,4 +1,4 @@
-// Decoratore
+// Decorators
 export { jsonIgnore } from "./decorators/JsonIgnore.js";
 export { jsonName } from "./decorators/JsonName.js";
 export { jsonObject } from "./decorators/JsonObject.js";

package/dist/models/AcceptedType.d.ts

@@ -1,4 +1,10 @@
+/**
+ * Type definition for accepted types in serialization and deserialization.
+ */
 export type AcceptedType = BooleanConstructor | DateConstructor | NumberConstructor | ObjectConstructor | StringConstructor | SymbolConstructor | (new (...args: unknown[]) => object) | null | void;
 type IRecursiveArray<T> = (IRecursiveArray<T> | T)[];
+/**
+ * Type definition for recursive arrays of accepted types.
+ */
 export type AcceptedTypes = AcceptedType | IRecursiveArray<AcceptedType>;
 export {};

package/dist/models/SerializationSettings.d.ts

@@ -5,12 +5,36 @@ import { ReferenceLoopHandling } from "../enums/ReferenceLoopHandling.js";
 import { MissingMemberHandling } from "../enums/MissingMemberHandling.js";
 import { DateFormatHandling } from "../enums/DateFormatHandling.js";
 import type { INamingStrategy } from "../naming-strategies/INamingStrategy.js";
+/**
+ * Class representing serialization settings.
+ */
 export declare class SerializationSettings {
+    /**
+     * Specifies how dates are formatted during serialization.
+     */
     dateFormatHandling: DateFormatHandling;
+    /**
+     * Specifies how missing members are handled during deserialization.
+     */
     missingMemberHandling: MissingMemberHandling;
+    /**
+     * Specifies how reference loops are handled during serialization.
+     */
     referenceLoopHandling: ReferenceLoopHandling;
+    /**
+     * Specifies how null values are handled during serialization.
+     */
     nullValueHandling: NullValueHandling;
+    /**
+     * Specifies how default values are handled during serialization.
+     */
     defaultValueHandling: DefaultValueHandling;
+    /**
+     * Specifies the naming strategy for property names during serialization.
+     */
     namingStrategy: INamingStrategy | null;
+    /**
+     * Specifies the log level for serialization operations.
+     */
     logLevel: LogLevels;
 }

package/dist/models/SerializationSettings.js

@@ -5,12 +5,36 @@ import { ReferenceLoopHandling } from "../enums/ReferenceLoopHandling.js";
 import { MissingMemberHandling } from "../enums/MissingMemberHandling.js";
 import { DateFormatHandling } from "../enums/DateFormatHandling.js";
 // From newtonsoft https://www.newtonsoft.com/json/help/html/SerializationSettings.htm
+/**
+ * Class representing serialization settings.
+ */
 export class SerializationSettings {
+    /**
+     * Specifies how dates are formatted during serialization.
+     */
     dateFormatHandling = DateFormatHandling.IsoDateFormat;
+    /**
+     * Specifies how missing members are handled during deserialization.
+     */
     missingMemberHandling = MissingMemberHandling.Ignore;
+    /**
+     * Specifies how reference loops are handled during serialization.
+     */
     referenceLoopHandling = ReferenceLoopHandling.Serialize;
+    /**
+     * Specifies how null values are handled during serialization.
+     */
     nullValueHandling = NullValueHandling.Include;
+    /**
+     * Specifies how default values are handled during serialization.
+     */
     defaultValueHandling = DefaultValueHandling.Ignore;
+    /**
+     * Specifies the naming strategy for property names during serialization.
+     */
     namingStrategy = null;
+    /**
+     * Specifies the log level for serialization operations.
+     */
     logLevel = LogLevels.Warning;
 }

package/dist/naming-strategies/CamelCaseNamingStrategy.d.ts

@@ -1,5 +1,20 @@
 import type { INamingStrategy } from "./INamingStrategy.js";
+/**
+ * Naming strategy for converting property names to camel case.
+ */
 export declare class CamelCaseNamingStrategy implements INamingStrategy {
+    /**
+     * Converts a JSON property name to a camel case property name.
+     *
+     * @param {string} name - The JSON property name.
+     * @returns {string} - The camel case property name.
+     */
     fromJsonName(name: string): string;
+    /**
+     * Converts a camel case property name to a JSON property name.
+     *
+     * @param {string} name - The camel case property name.
+     * @returns {string} - The JSON property name.
+     */
     toJsonName(name: string): string;
 }

package/dist/naming-strategies/CamelCaseNamingStrategy.js

@@ -1,8 +1,23 @@
 /* eslint-disable class-methods-use-this */
+/**
+ * Naming strategy for converting property names to camel case.
+ */
 export class CamelCaseNamingStrategy {
+    /**
+     * Converts a JSON property name to a camel case property name.
+     *
+     * @param {string} name - The JSON property name.
+     * @returns {string} - The camel case property name.
+     */
     fromJsonName(name) {
         return name.slice(0, 1).toUpperCase() + name.slice(1, name.length);
     }
+    /**
+     * Converts a camel case property name to a JSON property name.
+     *
+     * @param {string} name - The camel case property name.
+     * @returns {string} - The JSON property name.
+     */
     toJsonName(name) {
         return name.slice(0, 1).toLowerCase() + name.slice(1, name.length);
     }

package/dist/naming-strategies/INamingStrategy.d.ts

@@ -1,4 +1,19 @@
+/**
+ * Interface for defining naming strategies for property names during serialization.
+ */
 export interface INamingStrategy {
+    /**
+     * Converts a JSON property name to a class property name.
+     *
+     * @param {string} name - The JSON property name.
+     * @returns {string} - The class property name.
+     */
     fromJsonName: (name: string) => string;
+    /**
+     * Converts a class property name to a JSON property name.
+     *
+     * @param {string} name - The class property name.
+     * @returns {string} - The JSON property name.
+     */
     toJsonName: (name: string) => string;
 }

package/dist/naming-strategies/KebabCaseNamingStrategy.d.ts

@@ -1,5 +1,20 @@
 import type { INamingStrategy } from "./INamingStrategy.js";
+/**
+ * Naming strategy for converting property names to kebab case.
+ */
 export declare class KebabCaseNamingStrategy implements INamingStrategy {
+    /**
+     * Converts a JSON property name to a kebab case property name.
+     *
+     * @param {string} name - The JSON property name.
+     * @returns {string} - The kebab case property name.
+     */
     fromJsonName(name: string): string;
+    /**
+     * Converts a kebab case property name to a JSON property name.
+     *
+     * @param {string} name - The kebab case property name.
+     * @returns {string} - The JSON property name.
+     */
     toJsonName(name: string): string;
 }

package/dist/naming-strategies/KebabCaseNamingStrategy.js

@@ -1,8 +1,23 @@
 /* eslint-disable class-methods-use-this */
+/**
+ * Naming strategy for converting property names to kebab case.
+ */
 export class KebabCaseNamingStrategy {
+    /**
+     * Converts a JSON property name to a kebab case property name.
+     *
+     * @param {string} name - The JSON property name.
+     * @returns {string} - The kebab case property name.
+     */
     fromJsonName(name) {
         return name.replace(/-\w/gu, (group) => group[1].toUpperCase());
     }
+    /**
+     * Converts a kebab case property name to a JSON property name.
+     *
+     * @param {string} name - The kebab case property name.
+     * @returns {string} - The JSON property name.
+     */
     toJsonName(name) {
         return name
             .split(/(?=[A-Z])/u)

package/dist/naming-strategies/PascalCaseNamingStrategy.d.ts

@@ -1,5 +1,20 @@
 import type { INamingStrategy } from "./INamingStrategy.js";
+/**
+ * Naming strategy for converting property names to Pascal case.
+ */
 export declare class PascalCaseNamingStrategy implements INamingStrategy {
+    /**
+     * Converts a JSON property name to a Pascal case property name.
+     *
+     * @param {string} name - The JSON property name.
+     * @returns {string} - The Pascal case property name.
+     */
     fromJsonName(name: string): string;
+    /**
+     * Converts a Pascal case property name to a JSON property name.
+     *
+     * @param {string} name - The Pascal case property name.
+     * @returns {string} - The JSON property name.
+     */
     toJsonName(name: string): string;
 }

package/dist/naming-strategies/PascalCaseNamingStrategy.js

@@ -1,8 +1,23 @@
 /* eslint-disable class-methods-use-this */
+/**
+ * Naming strategy for converting property names to Pascal case.
+ */
 export class PascalCaseNamingStrategy {
+    /**
+     * Converts a JSON property name to a Pascal case property name.
+     *
+     * @param {string} name - The JSON property name.
+     * @returns {string} - The Pascal case property name.
+     */
     fromJsonName(name) {
         return name.slice(0, 1).toLowerCase() + name.slice(1, name.length);
     }
+    /**
+     * Converts a Pascal case property name to a JSON property name.
+     *
+     * @param {string} name - The Pascal case property name.
+     * @returns {string} - The JSON property name.
+     */
     toJsonName(name) {
         return name.slice(0, 1).toUpperCase() + name.slice(1, name.length);
     }

package/dist/utils/ClassToFormData.d.ts

@@ -1 +1,9 @@
+/**
+ * Converts a class instance to FormData for use in AJAX forms.
+ *
+ * @param {object} obj - The class instance to convert.
+ * @param {string} [formPrefix] - Optional prefix for form property names.
+ * @param {FormData} [formData] - Optional existing FormData to update.
+ * @returns {FormData} - The resulting FormData object.
+ */
 export declare const classToFormData: (obj: object, formPrefix?: string, formData?: FormData) => FormData;

package/dist/utils/ClassToFormData.js

@@ -1,5 +1,14 @@
+/* eslint-disable max-statements */
+/* eslint-disable max-lines-per-function */
 import { getPropertyName } from "./GetProperyName.js";
-// eslint-disable-next-line max-statements, max-lines-per-function
+/**
+ * Converts a class instance to FormData for use in AJAX forms.
+ *
+ * @param {object} obj - The class instance to convert.
+ * @param {string} [formPrefix] - Optional prefix for form property names.
+ * @param {FormData} [formData] - Optional existing FormData to update.
+ * @returns {FormData} - The resulting FormData object.
+ */
 export const classToFormData = (obj, formPrefix, formData) => {
     const newFormData = formData ?? new FormData();
     const keys = Reflect.ownKeys(obj);

package/dist/utils/GetProperyName.d.ts

@@ -1,2 +1,10 @@
 import { SerializationSettings } from "../models/SerializationSettings.js";
+/**
+ * Retrieves the correct property name for serialization, considering decorators and settings.
+ *
+ * @param {object} obj - The object containing the property.
+ * @param {string} property - The source name of the property.
+ * @param {Partial<SerializationSettings>} [settings] - Optional serialization settings.
+ * @returns {string} - The correct property name for serialization.
+ */
 export declare const getPropertyName: (obj: object, property: string, settings?: Partial<SerializationSettings>) => string;

package/dist/utils/GetProperyName.js

@@ -1,6 +1,14 @@
+/* eslint-disable max-statements */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 import { Serializable } from "../classes/Serializable.js";
-// eslint-disable-next-line max-statements
+/**
+ * Retrieves the correct property name for serialization, considering decorators and settings.
+ *
+ * @param {object} obj - The object containing the property.
+ * @param {string} property - The source name of the property.
+ * @param {Partial<SerializationSettings>} [settings] - Optional serialization settings.
+ * @returns {string} - The correct property name for serialization.
+ */
 export const getPropertyName = (obj, property, settings) => {
     if (Reflect.hasMetadata("ts-serializable:jsonName", obj.constructor.prototype, property)) {
         return Reflect.getMetadata("ts-serializable:jsonName", obj.constructor.prototype, property);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-serializable",
-    "version": "4.0.0",
+    "version": "4.2.0",
     "author": "Eugene Labutin",
     "license": "MIT",
     "homepage": "https://github.com/LabEG/Serializable#readme",
@@ -37,14 +37,14 @@
         "@commitlint/cli": "^19.8.0",
         "@commitlint/config-conventional": "^19.8.0",
         "@favware/cliff-jumper": "^6.0.0",
-        "@labeg/code-style": "^6.2.0",
+        "@labeg/code-style": "^6.3.0",
         "@swc-node/register": "^1.10.10",
         "@types/chai": "^5.2.1",
         "chai": "^5.2.0",
         "husky": "^9.1.7",
         "lint-staged": "^15.5.0",
         "reflect-metadata": "^0.2.2",
-        "typescript": "^5.8.2"
+        "typescript": "^5.8.3"
     },
     "keywords": [
         "serialization",