release(@1.2.1): update docs

.npmrc

@@ -1,2 +1,2 @@
-# @stevenleep:registry=https://npm.pkg.github.com
-# //npm.pkg.github.com/:_authToken=$YOUR_GITHUB_TOKEN
+@stevenleep:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=$YOUR_GITHUB_TOKEN

docs/doc/enums/preset_preRelease.CompareStatusEnum.html

@@ -15,7 +15,7 @@
 <li><a href="preset_preRelease.CompareStatusEnum.html">CompareStatusEnum</a></li></ul>
 <h1>Enumeration CompareStatusEnum</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/preset/preRelease.ts#L9">preset/preRelease.ts:9</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/preset/preRelease.ts#L9">preset/preRelease.ts:9</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,22 +34,22 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>Equal</span><a href="#Equal" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">Equal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;equal&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/preset/preRelease.ts#L12">preset/preRelease.ts:12</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/preset/preRelease.ts#L12">preset/preRelease.ts:12</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Error" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Error</span><a href="#Error" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;error&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/preset/preRelease.ts#L13">preset/preRelease.ts:13</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/preset/preRelease.ts#L13">preset/preRelease.ts:13</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Negative" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Negative</span><a href="#Negative" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Negative<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;negative&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/preset/preRelease.ts#L11">preset/preRelease.ts:11</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/preset/preRelease.ts#L11">preset/preRelease.ts:11</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Positive" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Positive</span><a href="#Positive" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">Positive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;positive&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/preset/preRelease.ts#L10">preset/preRelease.ts:10</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/preset/preRelease.ts#L10">preset/preRelease.ts:10</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/index.compare.html

@@ -36,7 +36,7 @@ <h5>lastVersion: <span class="tsd-signature-type">string</span></h5></li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/index.EnhanceEventsParserOption.html" class="tsd-signature-type" data-tsd-kind="Interface">EnhanceEventsParserOption</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">Result</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/index.ts#L15">index.ts:15</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/index.ts#L15">index.ts:15</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/preset_preRelease.comparePreRelease.html

@@ -29,7 +29,7 @@ <h5>current: <span class="tsd-signature-type">string</span></h5></li>
 <h5>last: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/preset_preRelease.CompareResult.html" class="tsd-signature-type" data-tsd-kind="Interface">CompareResult</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/preset/preRelease.ts#L36">preset/preRelease.ts:36</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/preset/preRelease.ts#L36">preset/preRelease.ts:36</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/preset_preRelease.createCompareResult.html

@@ -27,7 +27,7 @@ <h5>isGreater: <span class="tsd-signature-type">boolean</span></h5></li>
 <h5>weight: <span class="tsd-signature-type">number</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/preset_preRelease.CompareResult.html" class="tsd-signature-type" data-tsd-kind="Interface">CompareResult</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/preset/preRelease.ts#L21">preset/preRelease.ts:21</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/preset/preRelease.ts#L21">preset/preRelease.ts:21</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/utils.autoIteratorActuator.html

@@ -32,7 +32,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>iterator: <span class="tsd-signature-type">Iterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">IteratorItem</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/utils/index.ts#L26">utils/index.ts:26</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/utils/index.ts#L26">utils/index.ts:26</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/utils.available2Number.html

@@ -25,7 +25,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>version: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/utils/index.ts#L11">utils/index.ts:11</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/utils/index.ts#L11">utils/index.ts:11</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/utils.isNegative.html

@@ -25,7 +25,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>num: <span class="tsd-signature-type">number</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/utils/index.ts#L19">utils/index.ts:19</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/utils/index.ts#L19">utils/index.ts:19</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/utils.isPositive.html

@@ -25,7 +25,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>num: <span class="tsd-signature-type">number</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/utils/index.ts#L22">utils/index.ts:22</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/utils/index.ts#L22">utils/index.ts:22</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/utils.tryString2Number.html

@@ -25,7 +25,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/utils/index.ts#L3">utils/index.ts:3</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/utils/index.ts#L3">utils/index.ts:3</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/functions/utils_diff.horspool.html

@@ -39,7 +39,7 @@ <h5>pointer<span class="tsd-signature-symbol">: </span><span class="tsd-signatur
 <li class="tsd-parameter">
 <h5>words<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ArrayItem</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ArrayItem</span><span class="tsd-signature-symbol">]</span></h5></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/31c5e0a/src/utils/diff.ts#L3">utils/diff.ts:3</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/stevenleep/comparison/blob/5cddaf0/src/utils/diff.ts#L3">utils/diff.ts:3</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/doc/index.html

@@ -28,7 +28,7 @@ <h1>A semantic version comparison tool</h1>
 <a href="#install" id="install" style="color: inherit; text-decoration: none;">
   <h2>Install</h2>
 </a>
-<pre><code class="language-bash"><span class="hl-0">pnpm install @renovator/version</span>
+<pre><code class="language-bash"><span class="hl-0">pnpm install @stevenleep/comparison</span>
 </code></pre>
 
 <a href="#features" id="features" style="color: inherit; text-decoration: none;">
@@ -48,7 +48,7 @@ <h2>API</h2>
 </a>
 <ul>
 <li><p><a href="https://branlice.github.io/version/modules.html">API Documents</a></p>
-<pre><code class="language-typescript"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">compare</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;@renovator/version&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">version1</span><span class="hl-0"> = </span><span class="hl-3">&quot;1.0.0&quot;</span><span class="hl-0">;</span><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">version2</span><span class="hl-0"> = </span><span class="hl-3">&quot;2.0.0&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">result</span><span class="hl-0"> = </span><span class="hl-6">compare</span><span class="hl-0">(</span><span class="hl-2">version1</span><span class="hl-0">, </span><span class="hl-2">version2</span><span class="hl-0">);</span><br/><span class="hl-2">result</span><span class="hl-0">.</span><span class="hl-2">isGreater</span><span class="hl-0">; </span><span class="hl-7">// false</span><br/><span class="hl-2">result</span><span class="hl-0">.</span><span class="hl-2">status</span><span class="hl-0">; </span><span class="hl-7">// negative</span>
+<pre><code class="language-typescript"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">compare</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;@stevenleep/comparison&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">version1</span><span class="hl-0"> = </span><span class="hl-3">&quot;1.0.0&quot;</span><span class="hl-0">;</span><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">version2</span><span class="hl-0"> = </span><span class="hl-3">&quot;2.0.0&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">result</span><span class="hl-0"> = </span><span class="hl-6">compare</span><span class="hl-0">(</span><span class="hl-2">version1</span><span class="hl-0">, </span><span class="hl-2">version2</span><span class="hl-0">);</span><br/><span class="hl-2">result</span><span class="hl-0">.</span><span class="hl-2">isGreater</span><span class="hl-0">; </span><span class="hl-7">// false</span><br/><span class="hl-2">result</span><span class="hl-0">.</span><span class="hl-2">status</span><span class="hl-0">; </span><span class="hl-7">// negative</span>
 </code></pre>
 </li>
 <li><p>the comparison of the version is only one of the application scenarios. Parser at the bottom only provides the ability to install specific characters split. You can expand a lot of things based on this (depending on your own interests and ideas)</p>