Merge pull request #177 from farhan7reza7/v3.1.2

V3.1.2: update doc to document Date integration
farhan7reza7 · Mar 6, 2024 · 2c22e35 · 2c22e35
2 parents 353703c + 98e94e7
commit 2c22e35
Show file tree

Hide file tree

Showing 4 changed files with 100 additions and 16 deletions.
diff --git a/docs/diff-dates.js.html b/docs/diff-dates.js.html
@@ -70,15 +70,44 @@ <h1 class="page-title">Source: diff-dates.js</h1>
 
 </div>
 
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="global.html#DatesYMD">DatesYMD</a></li></ul><h3>Global</h3><ul><li><a href="global.html#diffDates">diffDates</a></li></ul>
-</nav>
-
+    <nav>
+      <h2><a href="index.html">Home</a></h2>
+      <h3>Classes</h3>
+      <ul>
+        <li><a href="global.html#DatesYMD">DatesYMD</a></li>
+      </ul>
+      <h3>Global</h3>
+      <ul>
+        <li><a href="global.html#DatesYMD">DatesYMD</a></li>
+      </ul>
+      <h3>Global object special method</h3>
+      <ul>
+        <li><a href="global.html#diffDates">diffDates</a></li>
+      </ul>
+      <h3>diff as Global Date Object method</h3>
+      <ul>
+        <li><a href="global.html#diff">diff</a></li>
+      </ul>
+      <h3>DatesYMD Methods</h3>
+      <ul>
+        <li><a href="global.html#customizeFormat">customizeFormat</a></li>
+        <li><a href="global.html#diffArray">diffArray</a></li>
+        <li><a href="global.html#diffInDays">diffInDays</a></li>
+        <li><a href="global.html#diffInHours">diffInHours</a></li>
+        <li><a href="global.html#diffInMinutes">diffInMinutes</a></li>
+        <li><a href="global.html#diffInMonths">diffInMonths</a></li>
+        <li><a href="global.html#diffInSeconds">diffInSeconds</a></li>
+        <li><a href="global.html#diffInWeeks">diffInWeeks</a></li>
+        <li><a href="global.html#diffInYears">diffInYears</a></li>
+        <li><a href="global.html#formattedYMD">formattedYMD</a></li>
+      </ul>
+    </nav>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 14:38:46 GMT+0530 (India Standard Time)
-</footer>
+      Documentation generated for
+      <a href="https://www.npmjs.com/package/diff-ymd-package">diff-ymd-package</a>    
+    </footer>
 
 <script> prettyPrint(); </script>
 <script src="scripts/linenumber.js"> </script>

diff --git a/docs/diff-ymd.js.html b/docs/diff-ymd.js.html
@@ -733,7 +733,6 @@ <h4>diff-ymd-package provides APIs for calculating the difference between two da
         </article>
       </section>
     </div>
-
     <nav>
       <h2><a href="index.html">Home</a></h2>
       <h3>Classes</h3>
@@ -748,6 +747,10 @@ <h3>Global object special method</h3>
       <ul>
         <li><a href="global.html#diffDates">diffDates</a></li>
       </ul>
+      <h3>diff as Global Date Object method</h3>
+      <ul>
+        <li><a href="global.html#diff">diff</a></li>
+      </ul>
       <h3>DatesYMD Methods</h3>
       <ul>
         <li><a href="global.html#customizeFormat">customizeFormat</a></li>
@@ -762,7 +765,6 @@ <h3>DatesYMD Methods</h3>
         <li><a href="global.html#formattedYMD">formattedYMD</a></li>
       </ul>
     </nav>
-
     <br class="clear" />
 
     <footer>

diff --git a/docs/global-DatesYMD.html b/docs/global-DatesYMD.html
@@ -1457,7 +1457,7 @@ <h5>Returns:</h5>
 
 </div>
 
-  <nav>
+    <nav>
       <h2><a href="index.html">Home</a></h2>
       <h3>Classes</h3>
       <ul>
@@ -1471,6 +1471,10 @@ <h3>Global object special method</h3>
       <ul>
         <li><a href="global.html#diffDates">diffDates</a></li>
       </ul>
+      <h3>diff as Global Date Object method</h3>
+      <ul>
+        <li><a href="global.html#diff">diff</a></li>
+      </ul>
       <h3>DatesYMD Methods</h3>
       <ul>
         <li><a href="global.html#customizeFormat">customizeFormat</a></li>
@@ -1487,11 +1491,12 @@ <h3>DatesYMD Methods</h3>
     </nav>
 <br class="clear">
 
-    <footer>
+<footer>
       Documentation generated for
       <a href="https://www.npmjs.com/package/diff-ymd-package">diff-ymd-package</a>    
     </footer>
 
+
 <script> prettyPrint(); </script>
 <script src="scripts/linenumber.js"> </script>
 </body>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -62,6 +62,23 @@ <h1 class="page-title">Source: index.js</h1>
  */
 const diffDates = require("./diff-dates");
 
+/**
+ * Makes the `diff` method available as the method of the Date object on importing the diff-ymd-package.
+ *
+ * This method creates an instance of DatesYMD to calculates the difference between Date instance and the passed date.
+ *
+ * @function
+ * @memberof Date.prototype
+ * @name diff
+ * @param {string} date (type- String but Number for epoch, and Object for dateObject) - The date to be differed, in the format 'yyyy-mm-dd' or 'yyyy/mm/dd' or yyyy.mm.dd or dateString or dateObject or Timestamp(epoch).
+ * @returns {DatesYMD} An object containing methods for date difference calculations.
+ */
+if (!Date.prototype.diff) {
+  Date.prototype.diff = function (date) {
+    return diffDates(this, date);
+  };
+}
+
 // Export the DatesYMD class and equivalent function diffDates for usages in other modules
 module.exports = DatesYMD; // default export for class
 module.exports.diffDates = diffDates; // named export for equivalent function
@@ -71,18 +88,49 @@ <h1 class="page-title">Source: index.js</h1>
 
 
 
-
 </div>
 
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="global.html#DatesYMD">DatesYMD</a></li></ul><h3>Global</h3><ul><li><a href="global.html#diffDates">diffDates</a></li></ul>
-</nav>
+    <nav>
+      <h2><a href="index.html">Home</a></h2>
+      <h3>Classes</h3>
+      <ul>
+        <li><a href="global.html#DatesYMD">DatesYMD</a></li>
+      </ul>
+      <h3>Global</h3>
+      <ul>
+        <li><a href="global.html#DatesYMD">DatesYMD</a></li>
+      </ul>
+      <h3>Global object special method</h3>
+      <ul>
+        <li><a href="global.html#diffDates">diffDates</a></li>
+      </ul>
+      <h3>diff as Global Date Object method</h3>
+      <ul>
+        <li><a href="global.html#diff">diff</a></li>
+      </ul>
+      <h3>DatesYMD Methods</h3>
+      <ul>
+        <li><a href="global.html#customizeFormat">customizeFormat</a></li>
+        <li><a href="global.html#diffArray">diffArray</a></li>
+        <li><a href="global.html#diffInDays">diffInDays</a></li>
+        <li><a href="global.html#diffInHours">diffInHours</a></li>
+        <li><a href="global.html#diffInMinutes">diffInMinutes</a></li>
+        <li><a href="global.html#diffInMonths">diffInMonths</a></li>
+        <li><a href="global.html#diffInSeconds">diffInSeconds</a></li>
+        <li><a href="global.html#diffInWeeks">diffInWeeks</a></li>
+        <li><a href="global.html#diffInYears">diffInYears</a></li>
+        <li><a href="global.html#formattedYMD">formattedYMD</a></li>
+      </ul>
+    </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 14:38:46 GMT+0530 (India Standard Time)
-</footer>
+      Documentation generated for
+      <a href="https://www.npmjs.com/package/diff-ymd-package">diff-ymd-package</a>    
+    </footer>
+
+
 
 <script> prettyPrint(); </script>
 <script src="scripts/linenumber.js"> </script>