deploy: 726082b

versions/doc-improvements/docs/api/bait/index.html

@@ -16,8 +16,7 @@
 </span></span><span style=display:flex><span><span style=color:#080;font-weight:700>end</span>)
 </span></span></code></pre></div><p>What this does is, whenever the <code>command.exit</code> event is thrown,
 this function will set the user prompt.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#catch>catch(name, cb)</a></td><td>Catches a hook with <code>name</code>. Runs the <code>cb</code> when it is thrown</td></tr><tr><td><a href=#catchOnce>catchOnce(name, cb)</a></td><td>Same as catch, but only runs the <code>cb</code> once and then removes the hook</td></tr><tr><td><a href=#hooks>hooks(name) -> table</a></td><td>Returns a table with hooks (callback functions) on the event with <code>name</code>.</td></tr><tr><td><a href=#release>release(name, catcher)</a></td><td>Removes the <code>catcher</code> for the event with <code>name</code>.</td></tr><tr><td><a href=#throw>throw(name, &mldr;args)</a></td><td>Throws a hook with <code>name</code> with the provided <code>args</code></td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=catch><h4 class=heading>bait.catch(name, cb)
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#catch>catch(name, cb)</a></td><td>Catches a hook with <code>name</code>. Runs the <code>cb</code> when it is thrown</td></tr><tr><td><a href=#catchOnce>catchOnce(name, cb)</a></td><td>Same as catch, but only runs the <code>cb</code> once and then removes the hook</td></tr><tr><td><a href=#hooks>hooks(name) -> table</a></td><td>Returns a table with hooks (callback functions) on the event with <code>name</code>.</td></tr><tr><td><a href=#release>release(name, catcher)</a></td><td>Removes the <code>catcher</code> for the event with <code>name</code>.</td></tr><tr><td><a href=#throw>throw(name, &mldr;args)</a></td><td>Throws a hook with <code>name</code> with the provided <code>args</code></td></tr></tbody></table><hr><div id=catch><h4 class=heading>bait.catch(name, cb)
 <a href=#catch class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Catches a hook with <code>name</code>. Runs the <code>cb</code> when it is thrown</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>ummm</p><p><code>function</code> <strong><code>cb</code></strong><br>?</p></div><hr><div id=catchOnce><h4 class=heading>bait.catchOnce(name, cb)
 <a href=#catchOnce class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Same as catch, but only runs the <code>cb</code> once and then removes the hook</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/commander/index.html

@@ -18,8 +18,7 @@
 to get user input.</li><li><code>out</code> is standard output. This is usually where text meant for
 output should go.</li><li><code>err</code> is standard error. This sink is for writing errors, as the
 name would suggest.</li></ul><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#deregister>deregister(name)</a></td><td>Deregisters any command registered with <code>name</code></td></tr><tr><td><a href=#register>register(name, cb)</a></td><td>Register a command with <code>name</code> that runs <code>cb</code> when ran</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=deregister><h4 class=heading>commander.deregister(name)
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#deregister>deregister(name)</a></td><td>Deregisters any command registered with <code>name</code></td></tr><tr><td><a href=#register>register(name, cb)</a></td><td>Register a command with <code>name</code> that runs <code>cb</code> when ran</td></tr></tbody></table><hr><div id=deregister><h4 class=heading>commander.deregister(name)
 <a href=#deregister class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deregisters any command registered with <code>name</code></p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=register><h4 class=heading>commander.register(name, cb)
 <a href=#register class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Register a command with <code>name</code> that runs <code>cb</code> when ran</p><h5 id=parameters-1 class=heading>Parameters

versions/doc-improvements/docs/api/fs/index.html

@@ -5,8 +5,7 @@
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The fs module provides easy and simple access to filesystem functions
 and other things, and acts an addition to the Lua standard library&rsquo;s
 I/O and filesystem functions.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#abs>abs(path) -> string</a></td><td>Gives an absolute version of <code>path</code>.</td></tr><tr><td><a href=#basename>basename(path) -> string</a></td><td>Gives the basename of <code>path</code>. For the rules,</td></tr><tr><td><a href=#cd>cd(dir)</a></td><td>Changes directory to <code>dir</code></td></tr><tr><td><a href=#dir>dir(path) -> string</a></td><td>Returns the directory part of <code>path</code>. For the rules, see Go&rsquo;s</td></tr><tr><td><a href=#glob>glob(pattern) -> matches (table)</a></td><td>Glob all files and directories that match the pattern.</td></tr><tr><td><a href=#join>join(&mldr;) -> string</a></td><td>Takes paths and joins them together with the OS&rsquo;s</td></tr><tr><td><a href=#mkdir>mkdir(name, recursive)</a></td><td>Makes a directory called <code>name</code>. If <code>recursive</code> is true, it will create its parent directories.</td></tr><tr><td><a href=#readdir>readdir(dir) -> {}</a></td><td>Returns a table of files in <code>dir</code>.</td></tr><tr><td><a href=#stat>stat(path) -> {}</a></td><td>Returns a table of info about the <code>path</code>.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=abs><h4 class=heading>fs.abs(path) -> string
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#abs>abs(path) -> string</a></td><td>Gives an absolute version of <code>path</code>.</td></tr><tr><td><a href=#basename>basename(path) -> string</a></td><td>Gives the basename of <code>path</code>. For the rules,</td></tr><tr><td><a href=#cd>cd(dir)</a></td><td>Changes directory to <code>dir</code></td></tr><tr><td><a href=#dir>dir(path) -> string</a></td><td>Returns the directory part of <code>path</code>. For the rules, see Go&rsquo;s</td></tr><tr><td><a href=#glob>glob(pattern) -> matches (table)</a></td><td>Glob all files and directories that match the pattern.</td></tr><tr><td><a href=#join>join(&mldr;) -> string</a></td><td>Takes paths and joins them together with the OS&rsquo;s</td></tr><tr><td><a href=#mkdir>mkdir(name, recursive)</a></td><td>Makes a directory called <code>name</code>. If <code>recursive</code> is true, it will create its parent directories.</td></tr><tr><td><a href=#readdir>readdir(dir) -> {}</a></td><td>Returns a table of files in <code>dir</code>.</td></tr><tr><td><a href=#stat>stat(path) -> {}</a></td><td>Returns a table of info about the <code>path</code>.</td></tr></tbody></table><hr><div id=abs><h4 class=heading>fs.abs(path) -> string
 <a href=#abs class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Gives an absolute version of <code>path</code>.</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=basename><h4 class=heading>fs.basename(path) -> string
 <a href=#basename class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Gives the basename of <code>path</code>. For the rules,

versions/doc-improvements/docs/api/hilbish/hilbish.aliases/index.html

@@ -3,8 +3,7 @@
 <button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
 <span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/ class=nav-link>Module hilbish.completions</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/ class=nav-link>Module hilbish.editor</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/ class=nav-link>Module hilbish.history</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/ class=nav-link>Module hilbish.jobs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/ class=nav-link>Module hilbish.os</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/ class=nav-link>Module hilbish.timers</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/doc-improvements/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.aliases</h1><p><em>command aliasing<br></em></p><h3 id=introduction class=heading>Introduction
 <a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The alias interface deals with all command aliases in Hilbish.</p><h3 id=functions class=heading>Functions
-<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#aliases.add>add(alias, cmd)</a></td><td>This is an alias (ha) for the <code>hilbish.alias</code> function.</td></tr><tr><td><a href=#aliases.delete>delete(name)</a></td><td>Removes an alias.</td></tr><tr><td><a href=#aliases.list>list() -> table&lt;string, string></a></td><td>Get a table of all aliases, with string keys as the alias and the value as the command.</td></tr><tr><td><a href=#aliases.resolve>resolve(alias) -> command (string)</a></td><td>Tries to resolve an alias to its command.</td></tr></tbody></table><h3 id=functions-1 class=heading>Functions
-<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><div id=aliases.add><h4 class=heading>hilbish.aliases.add(alias, cmd)
+<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#aliases.add>add(alias, cmd)</a></td><td>This is an alias (ha) for the <code>hilbish.alias</code> function.</td></tr><tr><td><a href=#aliases.delete>delete(name)</a></td><td>Removes an alias.</td></tr><tr><td><a href=#aliases.list>list() -> table&lt;string, string></a></td><td>Get a table of all aliases, with string keys as the alias and the value as the command.</td></tr><tr><td><a href=#aliases.resolve>resolve(alias) -> command (string)</a></td><td>Tries to resolve an alias to its command.</td></tr></tbody></table><hr><div id=aliases.add><h4 class=heading>hilbish.aliases.add(alias, cmd)
 <a href=#aliases.add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>This is an alias (ha) for the <code>hilbish.alias</code> function.</p><h5 id=parameters class=heading>Parameters
 <a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=aliases.delete><h4 class=heading>hilbish.aliases.delete(name)
 <a href=#aliases.delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Removes an alias.</p><h5 id=parameters-1 class=heading>Parameters