Merge pull request #176 from farhan7reza7/v3.1.2

updated doc to document diff as Date method
farhan7reza7 · Mar 6, 2024 · 353703c · 353703c
2 parents c494073 + 50f8945
commit 353703c
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -305,10 +305,17 @@ fixed some issues and configured files for publishing diff-ymd-package v2.0.2 on
 - Updated codebase for updating diff to best practiced 
 - fixed some other issues and configured files for v3.1.1
 
+### [v3.1.2]
+
+#### Fixed
+
+- updated doc for documenting latest Global Date integration following best practices
+- fixed some other issues and configured files for v2.3.2
+
 ### [Next Release] - Collecting issues and new features for next release
 
 ### Important changes links:
 
-- [Unreleased](https://github.com/farhan7reza7/diff-ymd-package/compare/v3.1.1...HEAD)
-- [v3.1.1](https://github.com/farhan7reza7/diff-ymd-package/releases/tag/v3.1.1)
+- [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)
 - [Next Release](https://github.com/farhan7reza7/diff-ymd-package/milestone/2)
diff --git a/docs/global.html b/docs/global.html
@@ -31,7 +31,77 @@ <h2></h2>
           <div class="container-overview">
             <dl class="details"></dl>
           </div>
+
+          <h3 class="subsection-title">diff as Global Date Object method</h3>
+
+          <h4 class="name" id="diff">
+            <span class="type-signature"></span>diffDates<span class="signature"
+              >(date)</span
+            ><span class="type-signature">
+              &rarr; {<a href="global.html#DatesYMD">DatesYMD</a>}</span
+            >
+          </h4>
+
+          <div class="description">Creates an instance of DatesYMD.</div>
 
+          <h5>Parameters:</h5>
+
+          <table class="params">
+            <thead>
+              <tr>
+                <th>Name</th>
+
+                <th>Type</th>
+
+                <th class="last">Description</th>
+              </tr>
+            </thead>
+
+            <tbody>
+
+              <tr>
+                <td class="name"><code>date</code></td>
+
+                <td class="type">
+                  <span class="param-type">string</span>
+                </td>
+
+                <td class="description last">
+                  (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).
+                </td>
+              </tr>
+            </tbody>
+          </table>
+
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="index.js.html">index.js</a>,
+                  <a href="index.js.html#line75">line 75</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+
+          <h5>Returns:</h5>
+
+          <div class="param-desc">
+            An object containing methods for date difference calculations.
+          </div>
+
+          <dl>
+            <dt>Type</dt>
+            <dd>
+              <span class="param-type"
+                ><a href="global.html#DatesYMD">DatesYMD</a></span
+              >
+            </dd>
+          </dl>
+
           <h3 class="subsection-title">Global DatesYMD methods</h3>
 
           <h4 class="name" id="diffDates">
@@ -707,6 +777,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>

diff --git a/docs/index.html b/docs/index.html
@@ -41,6 +41,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>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "diff-ymd-package",
-  "version": "3.1.1",
+  "name": "@farhan7reza7/diff-ymd-package",
+  "version": "3.1.2",
   "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": {