-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
WDH-Bot
committed
Dec 22, 2023
1 parent
73a18c7
commit 84dcd3f
Showing
1 changed file
with
204 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| <html lang="en"> | ||
| <head> | ||
| <meta charset='utf-8'> | ||
| <title>william.js 1.2.2 | Documentation</title> | ||
| <title>william.js 1.3.0 | Documentation</title> | ||
| <meta name='description' content='A super simple npm package with lots of utilities.'> | ||
| <meta name='viewport' content='width=device-width,initial-scale=1'> | ||
| <link href='assets/bass.css' rel='stylesheet'> | ||
|
|
@@ -15,7 +15,7 @@ | |
| <div id='split-left' class='overflow-auto fs0 height-viewport-100'> | ||
| <div class='py1 px2'> | ||
| <h3 class='mb0 no-anchor'>william.js</h3> | ||
| <div class='mb1'><code>1.2.2</code></div> | ||
| <div class='mb1'><code>1.3.0</code></div> | ||
| <input | ||
| placeholder='Filter' | ||
| id='filter-input' | ||
|
|
@@ -107,6 +107,26 @@ <h3 class='mb0 no-anchor'>william.js</h3> | |
|
|
||
| </li> | ||
|
|
||
|
|
||
| <li><a | ||
| href='#webhook' | ||
| class=""> | ||
| webhook | ||
|
|
||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
|
|
||
| <li><a | ||
| href='#email' | ||
| class=""> | ||
|
|
||
| </a> | ||
|
|
||
| </li> | ||
|
|
||
| </ul> | ||
| </div> | ||
| <div class='mt1 h6 quiet'> | ||
|
|
@@ -127,7 +147,7 @@ <h3 class='fl m0' id='cap'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/functions/cap.js#L17-L32'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/functions/cap.js#L17-L32'> | ||
| <span>src/functions/cap.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -233,7 +253,7 @@ <h3 class='fl m0' id='gravatar'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/functions/gravatar.js#L14-L25'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/functions/gravatar.js#L14-L25'> | ||
| <span>src/functions/gravatar.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -317,7 +337,7 @@ <h3 class='fl m0' id='id'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/functions/id.js#L37-L61'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/functions/id.js#L37-L61'> | ||
| <span>src/functions/id.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -443,7 +463,7 @@ <h3 class='fl m0' id='random'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/functions/random.js#L13-L25'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/functions/random.js#L13-L25'> | ||
| <span>src/functions/random.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -536,7 +556,7 @@ <h3 class='fl m0' id='getdirs'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/util/getDirs.js#L14-L22'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/util/getDirs.js#L14-L22'> | ||
| <span>src/util/getDirs.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -620,7 +640,7 @@ <h3 class='fl m0' id='md5hex'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/util/md5Hex.js#L20-L40'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/util/md5Hex.js#L20-L40'> | ||
| <span>src/util/md5Hex.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -707,7 +727,7 @@ <h3 class='fl m0' id='removeduplicates'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/util/removeDuplicates.js#L12-L18'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/util/removeDuplicates.js#L12-L18'> | ||
| <span>src/util/removeDuplicates.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -791,7 +811,7 @@ <h3 class='fl m0' id='uuid'> | |
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/7628506073d0d8ebfb330a07ded8d57c0cb25b65/src/functions/uuid.js#L23-L38'> | ||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/functions/uuid.js#L23-L38'> | ||
| <span>src/functions/uuid.js</span> | ||
| </a> | ||
|
|
||
|
|
@@ -870,6 +890,180 @@ <h3 class='fl m0' id='uuid'> | |
|
|
||
|
|
||
|
|
||
| </section> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <section class='p2 mb2 clearfix bg-white minishadow'> | ||
|
|
||
|
|
||
| <div class='clearfix'> | ||
|
|
||
| <h3 class='fl m0' id='webhook'> | ||
| webhook | ||
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/validate/discord.js#L15-L23'> | ||
| <span>src/validate/discord.js</span> | ||
| </a> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <div class='pre p1 fill-light mt0'>webhook(url: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class='py1 quiet mt1 prose-big'>Parameters</div> | ||
| <div class='prose'> | ||
|
|
||
| <div class='space-bottom0'> | ||
| <div> | ||
| <span class='code bold'>url</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code> | ||
| The webhook URL to test | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class='py1 quiet mt1 prose-big'>Returns</div> | ||
| <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>: | ||
| Whether the webhook URL passed the regex test | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class='py1 quiet mt1 prose-big'>Example</div> | ||
|
|
||
|
|
||
| <pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">import</span> { validate } <span class="hljs-keyword">from</span> <span class="hljs-string">"william.js"</span>; | ||
|
|
||
| validate.<span class="hljs-property">discord</span>.<span class="hljs-title function_">webhook</span>(<span class="hljs-string">"https://discord.com/api/webhooks/1234567890/abcdefghijklmnopqrstuvwxyz"</span>); | ||
| <span class="hljs-comment">//=> true</span> | ||
|
|
||
| validate.<span class="hljs-property">discord</span>.<span class="hljs-title function_">webhook</span>(<span class="hljs-string">"https://discord.com/api/webhooks/invalid/webhook"</span>); | ||
| <span class="hljs-comment">//=> false</span></pre> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </section> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <section class='p2 mb2 clearfix bg-white minishadow'> | ||
|
|
||
|
|
||
| <div class='clearfix'> | ||
|
|
||
| <h3 class='fl m0' id='email'> | ||
| </h3> | ||
|
|
||
|
|
||
| <a class='fr fill-darken0 round round pad1x quiet h5' href='https://github.com/wdhdev/william.js/blob/73a18c7221317634af81d6f79db4653c6ccfade5/src/validate/email.js#L15-L23'> | ||
| <span>src/validate/email.js</span> | ||
| </a> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <div class='pre p1 fill-light mt0'>email(email: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class='py1 quiet mt1 prose-big'>Parameters</div> | ||
| <div class='prose'> | ||
|
|
||
| <div class='space-bottom0'> | ||
| <div> | ||
| <span class='code bold'>email</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code> | ||
| The email address to test | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class='py1 quiet mt1 prose-big'>Returns</div> | ||
| <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>: | ||
| Whether the email address passed the regex test | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class='py1 quiet mt1 prose-big'>Example</div> | ||
|
|
||
|
|
||
| <pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">import</span> { validate } <span class="hljs-keyword">from</span> <span class="hljs-string">"william.js"</span>; | ||
|
|
||
| validate.<span class="hljs-title function_">email</span>(<span class="hljs-string">"[email protected]"</span>) | ||
| <span class="hljs-comment">//=> true</span> | ||
|
|
||
| validate.<span class="hljs-title function_">email</span>(<span class="hljs-string">"hello world"</span>) | ||
| <span class="hljs-comment">//=> false</span></pre> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </section> | ||
|
|
||
|
|
||
|
|
||