Skip to content

Commit

Permalink
Built and published by Moonwave
Browse files Browse the repository at this point in the history
  • Loading branch information
YetAnotherClown committed Aug 18, 2023
1 parent 197bbaf commit f800152
Show file tree
Hide file tree
Showing 21 changed files with 45 additions and 55 deletions.
8 changes: 4 additions & 4 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.3.1">
<title data-rh="true">Page Not Found | Luau-Future</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://yetanotherclown.github.io/Luau-Future/404.html"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | Luau-Future"><link data-rh="true" rel="canonical" href="https://yetanotherclown.github.io/Luau-Future/404.html"><link data-rh="true" rel="alternate" href="https://yetanotherclown.github.io/Luau-Future/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://yetanotherclown.github.io/Luau-Future/404.html" hreflang="x-default"><link rel="stylesheet" href="/Luau-Future/assets/css/styles.19a5646f.css">
<link rel="preload" href="/Luau-Future/assets/js/runtime~main.618a2f27.js" as="script">
<link rel="preload" href="/Luau-Future/assets/js/main.fdbba97b.js" as="script">
<link rel="preload" href="/Luau-Future/assets/js/runtime~main.d7ad647b.js" as="script">
<link rel="preload" href="/Luau-Future/assets/js/main.c3afe4f0.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/Luau-Future/"><b class="navbar__title text--truncate">Luau-Future</b></a><a class="navbar__item navbar__link" href="/Luau-Future/api/">API</a></div><div class="navbar__items navbar__items--right"><a href="https://discord.gg/gMWmuaZEY6" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><a href="https://github.com/Clownxz/Luau-Future" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Press S to Search..." aria-label="Search" class="navbar__search-input search-bar"></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/gMWmuaZEY6" target="_blank" rel="noopener noreferrer" class="footer__link-item">Clown&#x27;s Circus Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/YetAnotherClown" target="_blank" rel="noopener noreferrer" class="footer__link-item">YetAnotherClown on Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 YetAnotherClown. Built with Moonwave and Docusaurus</div></div></div></footer></div>
<script src="/Luau-Future/assets/js/runtime~main.618a2f27.js"></script>
<script src="/Luau-Future/assets/js/main.fdbba97b.js"></script>
<script src="/Luau-Future/assets/js/runtime~main.d7ad647b.js"></script>
<script src="/Luau-Future/assets/js/main.c3afe4f0.js"></script>
</body>
</html>
28 changes: 5 additions & 23 deletions api/Future/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@
Your Future could no longer be Pending but not return anything, in which case
``output()`` will return ``nil``.
:::"><link data-rh="true" rel="canonical" href="https://yetanotherclown.github.io/Luau-Future/api/Future"><link data-rh="true" rel="alternate" href="https://yetanotherclown.github.io/Luau-Future/api/Future" hreflang="en"><link data-rh="true" rel="alternate" href="https://yetanotherclown.github.io/Luau-Future/api/Future" hreflang="x-default"><link rel="stylesheet" href="/Luau-Future/assets/css/styles.19a5646f.css">
<link rel="preload" href="/Luau-Future/assets/js/runtime~main.618a2f27.js" as="script">
<link rel="preload" href="/Luau-Future/assets/js/main.fdbba97b.js" as="script">
<link rel="preload" href="/Luau-Future/assets/js/runtime~main.d7ad647b.js" as="script">
<link rel="preload" href="/Luau-Future/assets/js/main.c3afe4f0.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus">
Expand Down Expand Up @@ -168,8 +168,6 @@ <h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width=
<p>Polls the Future and returns <code>true</code> if the Future is pending.</p>
</div><div class="divider_rE5g"></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="isReady"><code style="text-decoration:none">isReady</code><a href="#isReady" class="hash-link" aria-label="Direct link to isReady" title="Direct link to isReady"></a></h3><div class="repositoryDetailsContainer_BPdw"><a class="sourceButton_sEho" href="https://github.com/Clownxz/Luau-Future/blob/main/lib/init.lua#L109"><div class="sourceButtonText_Vh0m">&lt;/&gt;</div></a></div><div class="memberString_GwaU"><code>Future<!-- -->:</code><code class="green_DgR4">isReady</code><code>(</code><code>) → </code><code class="blue_P4bS">boolean</code></div><div>
<p>Polls the Future and returns <code>true</code> if the Future is ready.</p>
</div><div class="divider_rE5g"></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="output"><code style="text-decoration:none">output</code><a href="#output" class="hash-link" aria-label="Direct link to output" title="Direct link to output"></a></h3><div class="repositoryDetailsContainer_BPdw"><a class="sourceButton_sEho" href="https://github.com/Clownxz/Luau-Future/blob/main/lib/init.lua#L121"><div class="sourceButtonText_Vh0m">&lt;/&gt;</div></a></div><div class="memberString_GwaU"><code>Future<!-- -->:</code><code class="green_DgR4">output</code><code>(</code><code>) → </code><code class="blue_P4bS">...T?</code></div><div>
<p>If the Future is ready, returns the results <code>...T</code>. Otherwise, returns <code>nil</code>.</p>
</div><div class="divider_rE5g"></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="output"><code style="text-decoration:none">output</code><a href="#output" class="hash-link" aria-label="Direct link to output" title="Direct link to output"></a></h3><div class="repositoryDetailsContainer_BPdw"><a class="sourceButton_sEho" href="https://github.com/Clownxz/Luau-Future/blob/main/lib/Output.lua#L13"><div class="sourceButtonText_Vh0m">&lt;/&gt;</div></a></div><div class="memberString_GwaU"><code>Future<!-- -->:</code><code class="green_DgR4">output</code><code>(</code><code>) → </code><code class="blue_P4bS"><a style="text-decoration:underline;color:inherit" href="/Luau-Future/api/Result">Result</a></code></div><div>
<p>When the Result of the Future is ready, calling <code>output</code> will return a <a href="https://yetanotherclown.github.io/Luau-Future/api/Result" target="_blank">Result</a>.</p>
</div></div></article></div><details><summary>Show raw api</summary><pre style="max-width:100%;white-space:pre-wrap">{
Expand Down Expand Up @@ -206,22 +204,6 @@ <h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width=
&quot;path&quot;: &quot;lib/init.lua&quot;
}
},
{
&quot;name&quot;: &quot;output&quot;,
&quot;desc&quot;: &quot;If the Future is ready, returns the results ``...T``. Otherwise, returns ``nil``.&quot;,
&quot;params&quot;: [],
&quot;returns&quot;: [
{
&quot;desc&quot;: &quot;&quot;,
&quot;lua_type&quot;: &quot;...T?&quot;
}
],
&quot;function_type&quot;: &quot;method&quot;,
&quot;source&quot;: {
&quot;line&quot;: 121,
&quot;path&quot;: &quot;lib/init.lua&quot;
}
},
{
&quot;name&quot;: &quot;output&quot;,
&quot;desc&quot;: &quot;When the Result of the Future is ready, calling ``output`` will return a [Result](https://yetanotherclown.github.io/Luau-Future/api/Result).&quot;,
Expand All @@ -247,8 +229,8 @@ <h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width=
&quot;line&quot;: 76,
&quot;path&quot;: &quot;lib/init.lua&quot;
}
}</pre></details></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#types" class="table-of-contents__link toc-highlight">Types</a></li><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a></li><li><a href="#functions" class="table-of-contents__link toc-highlight">Functions</a><ul><li><a href="#isPending" class="table-of-contents__link toc-highlight">:isPending</a></li><li><a href="#isReady" class="table-of-contents__link toc-highlight">:isReady</a></li><li><a href="#output" class="table-of-contents__link toc-highlight">:output</a></li><li><a href="#output" class="table-of-contents__link toc-highlight">:output</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/gMWmuaZEY6" target="_blank" rel="noopener noreferrer" class="footer__link-item">Clown&#x27;s Circus Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/YetAnotherClown" target="_blank" rel="noopener noreferrer" class="footer__link-item">YetAnotherClown on Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 YetAnotherClown. Built with Moonwave and Docusaurus</div></div></div></footer></div>
<script src="/Luau-Future/assets/js/runtime~main.618a2f27.js"></script>
<script src="/Luau-Future/assets/js/main.fdbba97b.js"></script>
}</pre></details></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#types" class="table-of-contents__link toc-highlight">Types</a></li><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a></li><li><a href="#functions" class="table-of-contents__link toc-highlight">Functions</a><ul><li><a href="#isPending" class="table-of-contents__link toc-highlight">:isPending</a></li><li><a href="#isReady" class="table-of-contents__link toc-highlight">:isReady</a></li><li><a href="#output" class="table-of-contents__link toc-highlight">:output</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/gMWmuaZEY6" target="_blank" rel="noopener noreferrer" class="footer__link-item">Clown&#x27;s Circus Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/YetAnotherClown" target="_blank" rel="noopener noreferrer" class="footer__link-item">YetAnotherClown on Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 YetAnotherClown. Built with Moonwave and Docusaurus</div></div></div></footer></div>
<script src="/Luau-Future/assets/js/runtime~main.d7ad647b.js"></script>
<script src="/Luau-Future/assets/js/main.c3afe4f0.js"></script>
</body>
</html>
Loading

0 comments on commit f800152

Please sign in to comment.