docs: fix broken links and images

simplyhexagonal · Apr 30, 2024 · e1433f9 · e1433f9
1 parent be83eb3
commit e1433f9
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -52,9 +52,9 @@ To put this into perspective:
 
 You can calculate duplicate/collision probabilities using the included functions:
 
-- [availableUUIDs()](https://shortunique.id/classes/default.html#availableuuids)
-- [approxMaxBeforeCollision()](https://shortunique.id/classes/default.html#approxmaxbeforecollision)
-- [collisionProbability()](https://shortunique.id/classes/default.html#collisionprobability)
+- [availableUUIDs()](https://shortunique.id/classes/ShortUniqueId.html#availableUUIDs)
+- [approxMaxBeforeCollision()](https://shortunique.id/classes/ShortUniqueId.html#approxMaxBeforeCollision)
+- [collisionProbability()](https://shortunique.id/classes/ShortUniqueId.html#collisionProbability)
 
 _NOTE: 👆 On these links you will also find explanations for the math used within the functions._
 
@@ -306,7 +306,7 @@ function `uniqueness()` which provides a score (from 0 to 1) to rate the
 to 1, higher the uniqueness and thus better the quality).
 
 To find out more about the math behind these functions please refer to the
-<a target="_blank" href="https://shortunique.id/classes/default.html#collisionprobability">API Reference</a>.
+<a target="_blank" href="https://shortunique.id/classes/ShortUniqueId.html#collisionProbability">API Reference</a>.
 
 ## Acknowledgement and platform support
 

diff --git a/docs/classes/ShortUniqueId.html b/docs/classes/ShortUniqueId.html
diff --git a/docs/index.html b/docs/index.html
@@ -99,9 +99,9 @@ <h2>Random Color generator</h2>
 </ul>
 <p>You can calculate duplicate/collision probabilities using the included functions:</p>
 <ul>
-<li><a href="https://shortunique.id/classes/default.html#availableuuids">availableUUIDs()</a></li>
-<li><a href="https://shortunique.id/classes/default.html#approxmaxbeforecollision">approxMaxBeforeCollision()</a></li>
-<li><a href="https://shortunique.id/classes/default.html#collisionprobability">collisionProbability()</a></li>
+<li><a href="https://shortunique.id/classes/ShortUniqueId.html#availableUUIDs">availableUUIDs()</a></li>
+<li><a href="https://shortunique.id/classes/ShortUniqueId.html#approxMaxBeforeCollision">approxMaxBeforeCollision()</a></li>
+<li><a href="https://shortunique.id/classes/ShortUniqueId.html#collisionProbability">collisionProbability()</a></li>
 </ul>
 <p><em>NOTE: 👆 On these links you will also find explanations for the math used within the functions.</em></p>
 <hr>
@@ -181,7 +181,7 @@ <h2>Random Color generator</h2>
 &quot;quality&quot; of the combination of given dictionary and UUID length (the closer
 to 1, higher the uniqueness and thus better the quality).</p>
 <p>To find out more about the math behind these functions please refer to the
-<a target="_blank" href="https://shortunique.id/classes/default.html#collisionprobability">API Reference</a>.</p>
+<a target="_blank" href="https://shortunique.id/classes/ShortUniqueId.html#collisionProbability">API Reference</a>.</p>
 <a id="md:acknowledgement-and-platform-support" class="tsd-anchor"></a><h2><a href="#md:acknowledgement-and-platform-support">Acknowledgement and platform support</a></h2><p>This repo and npm package started as a straight up manual transpilation to ES6 of the <a href="https://github.com/serendipious/nodejs-short-uid">short-uid</a> npm package by <a href="https://github.com/serendipious/">Ankit Kuwadekar</a>.</p>
 <p><img src="https://raw.githubusercontent.com/jeanlescure/short-unique-id/main/assets/weekly-downloads.png" alt="image depicting over 200000 weekly npm downloads">
 <img src="https://raw.githubusercontent.com/jeanlescure/short-unique-id/main/assets/weekly-cdn-hits.png" alt="image depicting over 16000000 weekly cdn hits"></p>

diff --git a/docs/interfaces/ShortUniqueIdOptions.html b/docs/interfaces/ShortUniqueIdOptions.html
diff --git a/docs/interfaces/ShortUniqueIdRanges.html b/docs/interfaces/ShortUniqueIdRanges.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ShortUniqueIdRanges | short-unique-id - v5.1.1</title><meta name="description" content="Documentation for short-unique-id - v5.1.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="https://shortunique.id" class="title">ShortUniqueId - v5.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">short-unique-id - v5.1.1</a></li><li><a href="ShortUniqueIdRanges.html">ShortUniqueIdRanges</a></li></ul><h1>Interface ShortUniqueIdRanges</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ShortUniqueIdRanges</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">k</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4 class="tsd-before-signature">Indexable</h4><div class="tsd-signature"><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jeanlescure/short-unique-id/blob/dd84e675c73113886c36345d113a51943aa4b1fd/src/index.ts#L10">index.ts:10</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://web.archive.org/web/20230607190646/https://shortunique.id/">Previous Docs (v4)</a></nav><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>short-unique-id - v5.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script async src="https://www.googletagmanager.com/gtag/js?id=UA-159642755-1"></script><script>window.dataLayer = window.dataLayer || [];
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ShortUniqueIdRanges | short-unique-id - v5.1.1</title><meta name="description" content="Documentation for short-unique-id - v5.1.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="https://shortunique.id" class="title">ShortUniqueId - v5.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">short-unique-id - v5.1.1</a></li><li><a href="ShortUniqueIdRanges.html">ShortUniqueIdRanges</a></li></ul><h1>Interface ShortUniqueIdRanges</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ShortUniqueIdRanges</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">k</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4 class="tsd-before-signature">Indexable</h4><div class="tsd-signature"><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/jeanlescure/short-unique-id/blob/be83eb3c4e21e5480fc561987df757b495d743c6/src/index.ts#L10">index.ts:10</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://web.archive.org/web/20230607190646/https://shortunique.id/">Previous Docs (v4)</a></nav><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>short-unique-id - v5.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script async src="https://www.googletagmanager.com/gtag/js?id=UA-159642755-1"></script><script>window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());
 gtag('config', 'UA-159642755-1');</script><script async src="https://cdn.jsdelivr.net/npm/short-unique-id@latest/dist/short-unique-id.min.js" crossOrigin="anonymous"></script></body></html>