Merge pull request #184 from farhan7reza7/type-adder

resolving types issue

Author: farhan7reza7

CHANGELOG.md

@@ -135,7 +135,6 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.1 on
 
 fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on npm registry
 
-
 ### [v2.0.3]
 
 #### Fixed
@@ -146,8 +145,6 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 - updated varaibles keywords to modern Js keywords
 - fixed some other issues and configured files for v2.0.3
 
-
-
 ### [v2.1.0]
 
 #### Added
@@ -165,7 +162,6 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 - Modified internal structure: Refactored internal code for better readability and maintainability.
 - Enhanced README.md for follwing best practices
 
-
 #### Fixed
 
 - Fixed some issues related to the new changes.
@@ -180,10 +176,10 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 
 - Continuous Integration: Integrated automated testing with GitHub Actions for ongoing code quality assurance.
 
-
 ### [v2.1.1]
 
 #### Fixed
+
 - Updated package.json main field for corrected issue in v2.1.0
 - fixed some other issues and configured files for v2.1.1
 
@@ -217,6 +213,7 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 ### [v2.2.1]
 
 #### Fixed
+
 - Updated codebase for delivery library through cdn as well as npm
 - fixed some other issues and configured files for v2.2.1
 
@@ -242,19 +239,23 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 ### [v2.3.1]
 
 #### Fixed
+
 - Updated reademe doc for documenting cdn and npm approach following best practices
 - fixed some other issues and configured files for v2.3.1
 
 #### Changed
+
 - Updated links to abs url for cross compatibility
 
 ### [v2.3.2]
 
 #### Fixed
+
 - updated doc for documenting latest cdn and npm approach following best practices for v2.3.2
 - fixed some other issues and configured files for v2.3.2
 
 #### Changed
+
 - added security dependabot
 - added codeql
 
@@ -266,6 +267,7 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 - Updated the README.md documentation for following the best practices.
 
 #### Changed
+
 - Updated the README.md documentation for following the best practices.
 - Updated issue templates with correct descriptions and links
 
@@ -278,16 +280,16 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 
 - README.md updated: Added consistent formating and recommended for best practices.
 
-
 ### [v3.1.0]
 
 #### Added
 
-- **Simplification:** Integrate diff as global Date Object method on importing 
+- **Simplification:** Integrate diff as global Date Object method on importing
 - Added source codes for integrating to Date
 - Added the README.md codes for documenting integration.
 
 #### Changed
+
 - Updated the README.md documentation for documenting integration.
 - Updated source codes
 - Enhanced README.md for follwing best practices and recommended practices
@@ -302,7 +304,8 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 ### [v3.1.1]
 
 #### Fixed
-- Updated codebase for updating diff to best practiced 
+
+- Updated codebase for updating diff to best practiced
 - fixed some other issues and configured files for v3.1.1
 
 ### [v3.1.2]
@@ -312,10 +315,16 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 - updated doc for documenting latest Global Date integration following best practices
 - fixed some other issues and configured files for v2.3.2
 
+### [v3.1.3]
+
+#### Fixed
+
+- added diff-ymd-package.d.ts to resolve the types issue
+
 ### [Next Release] - Collecting issues and new features for next release
 
 ### Important changes links:
 
-- [Unreleased](https://github.com/farhan7reza7/diff-ymd-package/compare/v3.1.2...HEAD)
-- [v3.1.2](https://github.com/farhan7reza7/diff-ymd-package/releases/tag/v3.1.2)
+- [Unreleased](https://github.com/farhan7reza7/diff-ymd-package/compare/v3.1.3...HEAD)
+- [v3.1.3](https://github.com/farhan7reza7/diff-ymd-package/releases/tag/v3.1.3)
 - [Next Release](https://github.com/farhan7reza7/diff-ymd-package/milestone/2)

diff-ymd-package.d.ts

@@ -0,0 +1,34 @@
+declare class DatesYMD {
+  constructor(
+    firstDate: string | number | Date,
+    secondDate: string | number | Date,
+  );
+
+  diffArray(): [number, number, number, string];
+  formattedYMD(): string;
+  customizeFormat(
+    yearUnit: string,
+    monthUnit: string,
+    dayUnit: string,
+    partSeparator: string,
+  ): string;
+  diffInMonths(): number;
+  diffInWeeks(): number;
+  diffInDays(): number;
+  diffInYears(): number;
+  diffInHours(): number;
+  diffInMinutes(): number;
+  diffInSeconds(): number;
+}
+
+declare function diffDates(
+  firstDate: string | number | Date,
+  secondDate: string | number | Date,
+): DatesYMD;
+
+// The hybrid CommonJS module export:
+declare const diffYMDPackage: typeof DatesYMD & {
+  diffDates: typeof diffDates;
+};
+
+export = diffYMDPackage;

package.json

@@ -1,11 +1,12 @@
 {
   "name": "diff-ymd-package",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "A javascript library for calculating the difference between two dates in formatted ways like (aY bM cD)(aYears bMonths cDays) or customized desired formats like aY-bM-cD or aYears-bMonths-cDays or kDays or mWeeks or nMonths etc.",
   "main": "lib/index.js",
   "scripts": {
     "test": "jest"
   },
+  "types": "diff-ymd-package.d.ts",
   "keywords": [
     "diff-ymd-package",
     "ymd",