docs/assets/highlight.css

@@ -1,20 +1,24 @@
 :root {
-    --light-hl-0: #008000;
-    --dark-hl-0: #6A9955;
-    --light-hl-1: #AF00DB;
-    --dark-hl-1: #C586C0;
-    --light-hl-2: #000000;
-    --dark-hl-2: #D4D4D4;
-    --light-hl-3: #001080;
-    --dark-hl-3: #9CDCFE;
+    --light-hl-0: #0000FF;
+    --dark-hl-0: #569CD6;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #0070C1;
+    --dark-hl-2: #4FC1FF;
+    --light-hl-3: #795E26;
+    --dark-hl-3: #DCDCAA;
     --light-hl-4: #A31515;
     --dark-hl-4: #CE9178;
-    --light-hl-5: #0000FF;
-    --dark-hl-5: #569CD6;
-    --light-hl-6: #0070C1;
-    --dark-hl-6: #4FC1FF;
-    --light-hl-7: #795E26;
-    --dark-hl-7: #DCDCAA;
+    --light-hl-5: #008000;
+    --dark-hl-5: #6A9955;
+    --light-hl-6: #AF00DB;
+    --dark-hl-6: #C586C0;
+    --light-hl-7: #001080;
+    --dark-hl-7: #9CDCFE;
+    --light-hl-8: #000000FF;
+    --dark-hl-8: #D4D4D4;
+    --light-hl-9: #267F99;
+    --dark-hl-9: #4EC9B0;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -28,6 +32,8 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 } }
 
@@ -40,6 +46,8 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 } }
 
@@ -52,6 +60,8 @@ body.light {
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
     --code-background: var(--light-code-background);
 }
 
@@ -64,6 +74,8 @@ body.dark {
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
     --code-background: var(--dark-code-background);
 }
 
@@ -75,4 +87,6 @@ body.dark {
 .hl-5 { color: var(--hl-5); }
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
 pre, code { background: var(--code-background); }

docs/index.html

@@ -3,23 +3,23 @@
   <h1>@augu/utils</h1>
 </a>
 <blockquote>
-<p>🌸 <strong>Extra utilities to keep code consise and non-repeative.</strong></p>
+<p>🌸 <strong>Extra utilities to keep code consist and non-repetitive.</strong></p>
 </blockquote>
 
 <a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
   <h2>Usage</h2>
 </a>
-<pre><code class="language-js"><span class="hl-0">// ESM</span><br/><span class="hl-1">import</span><span class="hl-2"> </span><span class="hl-3">utils</span><span class="hl-2"> </span><span class="hl-1">from</span><span class="hl-2"> </span><span class="hl-4">&#39;@augu/utils&#39;</span><span class="hl-2">;</span><br/><br/><span class="hl-0">// CommonJS</span><br/><span class="hl-5">const</span><span class="hl-2"> </span><span class="hl-6">utils</span><span class="hl-2"> = </span><span class="hl-7">require</span><span class="hl-2">(</span><span class="hl-4">&#39;@augu/utils&#39;</span><span class="hl-2">);</span>
+<pre><code class="language-js"><span class="hl-5">// ESM</span><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-7">utils</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-4">&#39;@augu/utils&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// CommonJS</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">utils</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;@augu/utils&#39;</span><span class="hl-1">);</span>
 </code></pre>
 
 <a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
   <h2>Installation</h2>
 </a>
-<pre><code class="language-sh"><span class="hl-2">$ npm i @augu/utils</span>
+<pre><code class="language-sh"><span class="hl-1">$ npm i @augu/utils</span>
 </code></pre>
 
 <a href="#license" id="license" style="color: inherit; text-decoration: none;">
   <h2>License</h2>
 </a>
 <p><strong>@augu/utils</strong> is released under MIT License. :heart:</p>
-</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/EventBus.html" class="tsd-kind-icon">Event<wbr/>Bus</a></li><li class="tsd-kind-class"><a href="classes/Stopwatch.html" class="tsd-kind-icon">Stopwatch</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Ctor.html" class="tsd-kind-icon">Ctor</a></li><li class="tsd-kind-interface"><a href="interfaces/ReaddirOptions.html" class="tsd-kind-icon">Readdir<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#AllowedNames" class="tsd-kind-icon">Allowed<wbr/>Names</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ConstructorReturnType" class="tsd-kind-icon">Constructor<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DecoupleArray" class="tsd-kind-icon">Decouple<wbr/>Array</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DecouplePromise" class="tsd-kind-icon">Decouple<wbr/>Promise</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepPartial" class="tsd-kind-icon">Deep<wbr/>Partial</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepRequired" class="tsd-kind-icon">Deep<wbr/>Required</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DotNotation" class="tsd-kind-icon">Dot<wbr/>Notation</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#FilterFlags" class="tsd-kind-icon">Filter<wbr/>Flags</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#FilterOut" class="tsd-kind-icon">Filter<wbr/>Out</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#KeyToPropType" class="tsd-kind-icon">Key<wbr/>To<wbr/>Prop<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#MaybePromise" class="tsd-kind-icon">Maybe<wbr/>Promise</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ObjectKeysWithSeperator" class="tsd-kind-icon">Object<wbr/>Keys<wbr/>With<wbr/>Seperator</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#OmitUndefinedOrNull" class="tsd-kind-icon">Omit<wbr/>Undefined<wbr/>Or<wbr/>Null</a></li><li class="tsd-kind-variable"><a href="modules.html#DaysInWeek" class="tsd-kind-icon">Days<wbr/>In<wbr/>Week</a></li><li class="tsd-kind-variable"><a href="modules.html#Months" class="tsd-kind-icon">Months</a></li><li class="tsd-kind-variable"><a href="modules.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-function"><a href="modules.html#calculateHRTime" class="tsd-kind-icon">calculateHRTime</a></li><li class="tsd-kind-function"><a href="modules.html#firstUpper" class="tsd-kind-icon">first<wbr/>Upper</a></li><li class="tsd-kind-function"><a href="modules.html#formatDate" class="tsd-kind-icon">format<wbr/>Date</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getProperty" class="tsd-kind-icon">get<wbr/>Property</a></li><li class="tsd-kind-function"><a href="modules.html#humanize" class="tsd-kind-icon">humanize</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#isObject" class="tsd-kind-icon">is<wbr/>Object</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#omitUndefinedOrNull" class="tsd-kind-icon">omit<wbr/>Undefined<wbr/>Or<wbr/>Null</a></li><li class="tsd-kind-function"><a href="modules.html#omitZero" class="tsd-kind-icon">omit<wbr/>Zero</a></li><li class="tsd-kind-function"><a href="modules.html#pluralize" class="tsd-kind-icon">pluralize</a></li><li class="tsd-kind-function"><a href="modules.html#readdir" class="tsd-kind-icon">readdir</a></li><li class="tsd-kind-function"><a href="modules.html#readdirSync" class="tsd-kind-icon">readdir<wbr/>Sync</a></li><li class="tsd-kind-function"><a href="modules.html#sleep" class="tsd-kind-icon">sleep</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
+</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/deprecate.html">deprecate</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/EventBus.html" class="tsd-kind-icon">Event<wbr/>Bus</a></li><li class="tsd-kind-class"><a href="classes/Stopwatch.html" class="tsd-kind-icon">Stopwatch</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Ctor.html" class="tsd-kind-icon">Ctor</a></li><li class="tsd-kind-interface"><a href="interfaces/NetworkInfo.html" class="tsd-kind-icon">Network<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/ReaddirOptions.html" class="tsd-kind-icon">Readdir<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#AllowedNames" class="tsd-kind-icon">Allowed<wbr/>Names</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ConstructorReturnType" class="tsd-kind-icon">Constructor<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DecoupleArray" class="tsd-kind-icon">Decouple<wbr/>Array</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DecouplePromise" class="tsd-kind-icon">Decouple<wbr/>Promise</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepPartial" class="tsd-kind-icon">Deep<wbr/>Partial</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepRequired" class="tsd-kind-icon">Deep<wbr/>Required</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DotNotation" class="tsd-kind-icon">Dot<wbr/>Notation</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#FilterFlags" class="tsd-kind-icon">Filter<wbr/>Flags</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#FilterOut" class="tsd-kind-icon">Filter<wbr/>Out</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#KeyToPropType" class="tsd-kind-icon">Key<wbr/>To<wbr/>Prop<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#MaybePromise" class="tsd-kind-icon">Maybe<wbr/>Promise</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ObjectKeysWithSeperator" class="tsd-kind-icon">Object<wbr/>Keys<wbr/>With<wbr/>Seperator</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#OmitUndefinedOrNull" class="tsd-kind-icon">Omit<wbr/>Undefined<wbr/>Or<wbr/>Null</a></li><li class="tsd-kind-variable"><a href="modules.html#DaysInWeek" class="tsd-kind-icon">Days<wbr/>In<wbr/>Week</a></li><li class="tsd-kind-variable"><a href="modules.html#Months" class="tsd-kind-icon">Months</a></li><li class="tsd-kind-variable"><a href="modules.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-function"><a href="modules.html#calculateHRTime" class="tsd-kind-icon">calculateHRTime</a></li><li class="tsd-kind-function"><a href="modules.html#firstUpper" class="tsd-kind-icon">first<wbr/>Upper</a></li><li class="tsd-kind-function"><a href="modules.html#formatDate" class="tsd-kind-icon">format<wbr/>Date</a></li><li class="tsd-kind-function"><a href="modules.html#getExternalNetwork" class="tsd-kind-icon">get<wbr/>External<wbr/>Network</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getProperty" class="tsd-kind-icon">get<wbr/>Property</a></li><li class="tsd-kind-function"><a href="modules.html#humanize" class="tsd-kind-icon">humanize</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#isObject" class="tsd-kind-icon">is<wbr/>Object</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#omitUndefinedOrNull" class="tsd-kind-icon">omit<wbr/>Undefined<wbr/>Or<wbr/>Null</a></li><li class="tsd-kind-function"><a href="modules.html#omitZero" class="tsd-kind-icon">omit<wbr/>Zero</a></li><li class="tsd-kind-function"><a href="modules.html#pluralize" class="tsd-kind-icon">pluralize</a></li><li class="tsd-kind-function"><a href="modules.html#readdir" class="tsd-kind-icon">readdir</a></li><li class="tsd-kind-function"><a href="modules.html#readdirSync" class="tsd-kind-icon">readdir<wbr/>Sync</a></li><li class="tsd-kind-function"><a href="modules.html#sleep" class="tsd-kind-icon">sleep</a></li><li class="tsd-kind-function"><a href="modules.html#titleCase" class="tsd-kind-icon">title<wbr/>Case</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>

docs/interfaces/Ctor.html

@@ -1,8 +1,8 @@
 <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Ctor | @augu/utils</title><meta name="description" content="Documentation for @augu/utils"/><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 async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">@augu/utils</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@augu/utils</a></li><li><a href="Ctor.html">Ctor</a></li></ul><h1>Interface Ctor&lt;T&gt;</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Represents a exported file</p>
-</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Ctor</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-interface"><a href="Ctor.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ctor.html#default" class="tsd-kind-icon">default</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-interface"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">new <wbr/>Ctor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/5d1de13/src/index.ts#L39">index.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Ctor</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-interface"><a href="Ctor.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ctor.html#default" class="tsd-kind-icon">default</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-interface"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">new <wbr/>Ctor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/610f551/src/index.ts#L42">index.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Constructs a new instance of [T]</p>
 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div><p>Any additional arguments, if any</p>
-</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="default" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default</h3><div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">?:</span> <a href="Ctor.html" class="tsd-signature-type" data-tsd-kind="Interface">Ctor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/5d1de13/src/index.ts#L44">index.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="default" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default</h3><div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">?:</span> <a href="Ctor.html" class="tsd-signature-type" data-tsd-kind="Interface">Ctor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/610f551/src/index.ts#L47">index.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Returns the default export of [T], if it was a ES module</p>
-</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-has-type-parameter"><a href="Ctor.html" class="tsd-kind-icon">Ctor</a><ul><li class="tsd-kind-constructor tsd-parent-kind-interface"><a href="Ctor.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ctor.html#default" class="tsd-kind-icon">default</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/deprecate.html">deprecate</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-has-type-parameter"><a href="Ctor.html" class="tsd-kind-icon">Ctor</a><ul><li class="tsd-kind-constructor tsd-parent-kind-interface"><a href="Ctor.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Ctor.html#default" class="tsd-kind-icon">default</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/NetworkInfo.html

@@ -0,0 +1,7 @@
+<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>NetworkInfo | @augu/utils</title><meta name="description" content="Documentation for @augu/utils"/><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 async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">@augu/utils</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@augu/utils</a></li><li><a href="NetworkInfo.html">NetworkInfo</a></li></ul><h1>Interface NetworkInfo</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Returns the network information from the <a href="../modules.html#getExternalNetwork">getExternalNetwork</a> function.</p>
+</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">NetworkInfo</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NetworkInfo.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NetworkInfo.html#family" class="tsd-kind-icon">family</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="address" class="tsd-anchor"></a><h3>address</h3><div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/610f551/src/index.ts#L148">index.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Returns the address of the network.</p>
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="family" class="tsd-anchor"></a><h3>family</h3><div class="tsd-signature tsd-kind-icon">family<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">6</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/610f551/src/index.ts#L143">index.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<p>Returns the family, which can be <code>4</code> or <code>6</code>.</p>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/deprecate.html">deprecate</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="NetworkInfo.html" class="tsd-kind-icon">Network<wbr/>Info</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NetworkInfo.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NetworkInfo.html#family" class="tsd-kind-icon">family</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

docs/interfaces/ReaddirOptions.html

@@ -1,5 +1,5 @@
-<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ReaddirOptions | @augu/utils</title><meta name="description" content="Documentation for @augu/utils"/><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 async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">@augu/utils</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@augu/utils</a></li><li><a href="ReaddirOptions.html">ReaddirOptions</a></li></ul><h1>Interface ReaddirOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ReaddirOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#exclude" class="tsd-kind-icon">exclude</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#extensions" class="tsd-kind-icon">extensions</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="exclude" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> exclude</h3><div class="tsd-signature tsd-kind-icon">exclude<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/5d1de13/src/index.ts#L57">index.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ReaddirOptions | @augu/utils</title><meta name="description" content="Documentation for @augu/utils"/><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 async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">@augu/utils</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@augu/utils</a></li><li><a href="ReaddirOptions.html">ReaddirOptions</a></li></ul><h1>Interface ReaddirOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ReaddirOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#exclude" class="tsd-kind-icon">exclude</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#extensions" class="tsd-kind-icon">extensions</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="exclude" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> exclude</h3><div class="tsd-signature tsd-kind-icon">exclude<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/610f551/src/index.ts#L60">index.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>List of directories to exclude or files</p>
-</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="extensions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> extensions</h3><div class="tsd-signature tsd-kind-icon">extensions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/5d1de13/src/index.ts#L54">index.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="extensions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> extensions</h3><div class="tsd-signature tsd-kind-icon">extensions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Noelware/utils/blob/610f551/src/index.ts#L57">index.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>List of extensions to check for</p>
-</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ReaddirOptions.html" class="tsd-kind-icon">Readdir<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#exclude" class="tsd-kind-icon">exclude</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#extensions" class="tsd-kind-icon">extensions</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
+</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/deprecate.html">deprecate</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ReaddirOptions.html" class="tsd-kind-icon">Readdir<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#exclude" class="tsd-kind-icon">exclude</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ReaddirOptions.html#extensions" class="tsd-kind-icon">extensions</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

index.d.ts

@@ -135,6 +135,11 @@ declare global {
    */
   // eslint-disable-next-line
   type DecoupleArray<T> = T extends Array<infer U> ? U : never;
+
+  /**
+   * Extracts all arguments and returns as a tuple from {@link F}.
+   */
+  type ExtractArguments<F> = F extends (...args: infer U) => any ? U : never;
 }
 
 declare namespace utils {
@@ -252,6 +257,26 @@ declare namespace utils {
   // eslint-disable-next-line
   type DecoupleArray<T> = T extends Array<infer U> ? U : never;
 
+  /**
+   * Extracts all arguments and returns as a tuple from {@link F}.
+   */
+  type ExtractArguments<F> = F extends (...args: infer U) => any ? U : never;
+
+  /**
+   * Returns the network information from the {@link getExternalNetwork} function.
+   */
+  interface NetworkInfo {
+    /**
+     * Returns the family, which can be `4` or `6`.
+     */
+    family: 4 | 6;
+
+    /**
+     * Returns the address of the network.
+     */
+    address: string;
+  }
+
   /** Returns the version of `@augu/utils` */
   export const version: string;
 
@@ -368,13 +393,38 @@ declare namespace utils {
 
   /**
    * Returns all the [text]'s first characters as upper case
+   *
+   * @deprecated
    * @param text The text provided
    * @param delim Optional delimiter to use (default is `' '`)
    * @example
    * firstUpper('i code good'); //=> I Code Good
    */
   export function firstUpper(text: string, delim?: string): string;
 
+  /**
+   * Returns all the [text]'s first characters as upper case
+   * @param text The text provided
+   * @param delim Optional delimiter to use (default is `' '`)
+   * @example
+   * titleCase('i code good'); //=> I Code Good
+   */
+  export const titleCase: typeof firstUpper;
+
+  /**
+   * Returns the external networks from the OS, if any.
+   * @param strictIPv4 If retriveing should only be only IPv4 interfaces.
+   * @returns The first non-internal network that the user can reach.
+   * @example
+   * ```js
+   * const { getExternalNetwork } = require('@augu/utils');
+   *
+   * const network = getExternalNetwork();
+   * // => { address: '127.0.0.1', family: 4 }
+   * ```
+   */
+  export function getExternalNetwork(strictIPv4?: boolean): NetworkInfo | null;
+
   /**
    * Represents a EventBus, an emittion tool to pass down data from one component to another
    */
@@ -475,6 +525,56 @@ declare namespace utils {
      */
     public end(): string;
   }
+
+  /**
+   * Namespace to deprecate functions, methods, properties, etc.
+   */
+  // eslint-disable-next-line
+  export namespace deprecate {
+    /**
+     * Deprecates a function from being used, it'll emit a warning using [process.emitWarning](https://nodejs.org/api/process.html#process_process_emitwarning_warning_options).
+     *
+     * @example
+     * ```js
+     * const { deprecate: { func: deprecateFunction } } = require('@augu/utils');
+     *
+     * const myFunc = deprecateFunction(() => {
+     *    return 'owo';
+     * }, '`myFunc` is deprecated and will be removed in a future release.', ['someOtherFunc']);
+     * ```
+     *
+     * @param f The function to use that is deprecated.
+     * @param message An alternative message instead of `Function myFunc is deprecated and will be removed in a future release.`
+     * @param alternatives A list of alternative functions that will be printed.
+     * @returns The function that will be ran BUT it'll emit a warning message.
+     */
+    export function func<F extends (...args: any[]) => any, U extends any[] = ExtractArguments<F>, R = ReturnType<F>>(
+      f: F,
+      message?: string | ((name: string, alternatives?: string[]) => string),
+      alternatives?: string[]
+    ): (...args: U) => R;
+
+    /**
+     * Decorator for deprecating a class that shouldn't be in-use.
+     *
+     * @example
+     * ```ts
+     * // This requires TypeScript since decorators are still in-proposal.
+     * import { deprecate } from '@augu/utils';
+     *
+     * (at)deprecate.Class((name, alternatives) => `Try out ${alternatives?.join(', ')}.`, ['owo', 'uwu'])
+     * class SomeClass {}
+     * ```
+     *
+     * @param message An alternative message instead of `Class "SomeClass" is deprecated and will be removed in a future release.`
+     * @param alternatives A list of alternative classes to print out.
+     * @returns The decorator hook to apply.
+     */
+    export function Class(
+      message?: string | ((name: string, alternatives: string[]) => string),
+      alternatives?: string[]
+    ): ClassDecorator;
+  }
 }
 
 export = utils;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@augu/utils",
   "description": "🌸 Extra utilities to keep code consist and non-repetitive.",
-  "version": "1.5.4",
+  "version": "1.5.5",
   "main": "build/index.js",
   "types": "index.d.ts",
   "author": "August <cutie@floofy.dev>",

tests/main.spec.ts

@@ -39,13 +39,6 @@ describe('Main Utilities', () => {
     });
   });
 
-  test('if we receive "$PWD/docs/docs.json" in the array', async () => {
-    const path = join(__dirname, '..', 'docs');
-    const files = await utils.readdir(path);
-
-    expect(files.length).toBe(16);
-  });
-
   test('if we should be able to exclude `build` and only have .md files returned', () => {
     const files = utils.readdirSync(__dirname, {
       exclude: ['dud'],