sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

deploy: 208bd594cb3325c6606c839db40f691a46ebd16a

gh-pages
TorchedSammy 2024-12-24 22:53:55 +00:00
parent 1e04b0bcd0
commit 1e9a8a6120
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
versions/document-lua/docs/api/hilbish/hilbish.runner/index.html
View File

@ -28,26 +28,24 @@ shell script if fennel eval has an error.</p><div class=highlight><pre tabindex=
</span></span><span class=line><span class=ln>11</span><span class=cl> <span class=kr>return</span> <span class=n>hilbish.runner</span><span class=p>.</span><span class=n>sh</span><span class=p>(</span><span class=n>input</span><span class=p>)</span>
</span></span><span class=line><span class=ln>12</span><span class=cl><span class=kr>end</span><span class=p>)</span>
</span></span></code></pre></div><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=#runner.setMode>setMode(cb)</a></td><td>This is the same as the <code>hilbish.runnerMode</code> function.</td></tr><tr><td><a href=#runner.lua>lua(cmd)</a></td><td>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code></td></tr><tr><td><a href=#runner.sh>sh(cmd)</a></td><td>Runs a command in Hilbish&rsquo;s shell script interpreter.</td></tr><tr><td><a href=#getCurrent></td><td>Returns the current runner by name.</td></tr><tr><td><a href=#setCurrent></td><td>Sets the current interactive/command line runner mode.</td></tr><tr><td><a href=#add></td><td>Adds a runner to the table of available runners. If runner is a table,</td></tr><tr><td><a href=#get></td><td>Get a runner by name.</td></tr><tr><td><a href=#set></td><td>Sets a runner by name. The runner table must have the run function in it.</td></tr><tr><td><a href=#exec></td><td>Executes cmd with a runner. If runnerName isn&rsquo;t passed, it uses</td></tr></tbody></table><h4 id=parameters class=heading>Parameters
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h4><p><code>function</code> <strong><code>cb</code></strong></p></div><hr><div id=runner.lua><h4 class=heading>hilbish.runner.lua(cmd)
<a href=#runner.lua class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code><br>or <code>load</code>, but is appropriated for the runner interface.</p><h5 id=parameters-1 class=heading>Parameters
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmd</code></strong></p></div><hr><div id=runner.sh><h4 class=heading>hilbish.runner.sh(cmd)
<a href=#runner.sh class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Runs a command in Hilbish&rsquo;s shell script interpreter.<br>This is the equivalent of using <code>source</code>.</p><h5 id=parameters-2 class=heading>Parameters
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmd</code></strong></p></div><hr><div id=getCurrent><h4 class=heading>hilbish.runner.getCurrent()
<a href=#getCurrent class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the current runner by name.</p><h5 id=parameters-3 class=heading>Parameters
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=setCurrent><h4 class=heading>hilbish.runner.setCurrent(name)
<a href=#setCurrent class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets the current interactive/command line runner mode.</p><h5 id=parameters-4 class=heading>Parameters
<a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=add><h4 class=heading>hilbish.runner.add(name, runner)
<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=#runner.setMode>setMode(cb)</a></td><td>This is the same as the <code>hilbish.runnerMode</code> function.</td></tr><tr><td><a href=#runner.lua>lua(cmd)</a></td><td>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code></td></tr><tr><td><a href=#runner.sh>sh(cmd)</a></td><td>Runs a command in Hilbish&rsquo;s shell script interpreter.</td></tr><tr><td><a href=#getCurrent>hilbish.runner.getCurrent()</a></td><td>Returns the current runner by name.</td></tr><tr><td><a href=#setCurrent>hilbish.runner.setCurrent(name)</a></td><td>Sets the current interactive/command line runner mode.</td></tr><tr><td><a href=#add>hilbish.runner.add(name, runner)</a></td><td>Adds a runner to the table of available runners. If runner is a table,</td></tr><tr><td><a href=#get>hilbish.runner.get(name)</a></td><td>Get a runner by name.</td></tr><tr><td><a href=#set>hilbish.runner.set(name, runner)</a></td><td>Sets a runner by name. The runner table must have the run function in it.</td></tr><tr><td><a href=#exec>hilbish.runner.exec(cmd, runnerName)</a></td><td>Executes cmd with a runner. If runnerName isn&rsquo;t passed, it uses</td></tr></tbody></table><blockquote></blockquote><p>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code><br>or <code>load</code>, but is appropriated for the runner interface.</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>cmd</code></strong></p></div><hr><div id=runner.sh><h4 class=heading>hilbish.runner.sh(cmd)
<a href=#runner.sh class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Runs a command in Hilbish&rsquo;s shell script interpreter.<br>This is the equivalent of using <code>source</code>.</p><h5 id=parameters-1 class=heading>Parameters
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmd</code></strong></p></div><hr><div id=getCurrent><h4 class=heading>hilbish.runner.getCurrent()
<a href=#getCurrent class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the current runner by name.</p><h5 id=parameters-2 class=heading>Parameters
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=setCurrent><h4 class=heading>hilbish.runner.setCurrent(name)
<a href=#setCurrent class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets the current interactive/command line runner mode.</p><h5 id=parameters-3 class=heading>Parameters
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=add><h4 class=heading>hilbish.runner.add(name, runner)
<a href=#add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Adds a runner to the table of available runners. If runner is a table,
it must have the run function in it.</p><h5 id=parameters-5 class=heading>Parameters
<a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong>
it must have the run function in it.</p><h5 id=parameters-4 class=heading>Parameters
<a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong>
<code>runner</code> <strong><code>function</code></strong></p></div><hr><div id=get><h4 class=heading>hilbish.runner.get(name)
<a href=#get class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Get a runner by name.</p><h5 id=parameters-6 class=heading>Parameters
<a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=set><h4 class=heading>hilbish.runner.set(name, runner)
<a href=#set class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets a runner by name. The runner table must have the run function in it.</p><h5 id=parameters-7 class=heading>Parameters
<a href=#parameters-7 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong>
<a href=#get class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Get a runner by name.</p><h5 id=parameters-5 class=heading>Parameters
<a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=set><h4 class=heading>hilbish.runner.set(name, runner)
<a href=#set class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets a runner by name. The runner table must have the run function in it.</p><h5 id=parameters-6 class=heading>Parameters
<a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong>
<code>runner</code> <strong><code>table</code></strong></p></div><hr><div id=exec><h4 class=heading>hilbish.runner.exec(cmd, runnerName)
<a href=#exec class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Executes cmd with a runner. If runnerName isn&rsquo;t passed, it uses
the user&rsquo;s current runner.</p><h5 id=parameters-8 class=heading>Parameters
<a href=#parameters-8 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>cmd</code> <strong><code>string</code></strong>
the user&rsquo;s current runner.</p><h5 id=parameters-7 class=heading>Parameters
<a href=#parameters-7 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>cmd</code> <strong><code>string</code></strong>
<code>runnerName</code> <strong><code>string?</code></strong></p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>