sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-07-01 16:52:03 +00:00
Code Issues Releases Wiki Activity
Hilbish/versions/new-website/docs/api/bait/index.html

110 lines
14 KiB
HTML
Raw Blame History

<!doctype html>
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="http://localhost:9080/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="http://localhost:9080/hilbish-flower.png" property="og:image"><meta content="Hilbish" property="og:title"><meta content="Hilbish" property="og:site_name"><meta content="website" property="og:type"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." property="og:description"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." name="description"><meta content="Lua,Shell,Hilbish,Linux,zsh,bash" name="keywords"><meta content="http://localhost:9080" property="og:url"></head><body class="h-screen flex flex-col"><nav class="bg-stone-100/80 dark:bg-neutral-950/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-12"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-8" src="http://localhost:9080/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3"><a href="http://localhost:9080/install"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Install</span></a><a href="http://localhost:9080/docs"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Docs</span></a><a href="http://localhost:9080/blog"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Blog</span></a></div></nav><div class="flex-1 flex flex-col overflow-hidden"><div class="sm:hidden h-10 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 dark:bg-zinc-800/50"><label class="cursor-pointer" for="sidebar-toggle"><tag><svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" class="fill-white"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span class="font-bold">Module bait</span></div><div class="flex-1 sm:flex grid overflow-hidden"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="overflow-y-scroll p-4 sm:border-r sm:border-r-zinc-300 col-start-1 row-start-1 bg-neutral-100 dark:bg-neutral-950 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul class="text-lg flex flex-col gap-2"><li class="font-bold"><a href="http://localhost:9080/docs">Introduction</a></li><li class="font-bold"><a href="http://localhost:9080/docs/getting-started">Getting Started</a></li><li class="font-bold"><a href="http://localhost:9080/docs/faq">Frequently Asked Questions</a></li><li class="font-bold"><a href="http://localhost:9080/docs/features">Features</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/completions">Completions</a></li><li class="mb-2"><a href="http://localhost:9080/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="http://localhost:9080/docs/features/opts">Options</a></li><li class="mb-2"><a href="http://localhost:9080/docs/features/runner-mode">Runner Mode</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/hooks">Signals</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/hooks/command">Command</a></li><li class="mb-2"><a href="http://localhost:9080/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="http://localhost:9080/docs/hooks/signal">Signal</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/lunacolors">Lunacolors</a></li><li class="font-bold"><a href="http://localhost:9080/docs/api">API</a></li><ul class="pl-4"><li class="mb-2 text-pink-400"><a href="http://localhost:9080/docs/api/bait"> -&gt; Module bait</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/readline">Module readline</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="http://localhost:9080/docs/api/yarn">Module yarn</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/nature">Nature</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="http://localhost:9080/docs/nature/doc">Module doc</a></li></ul><li class="font-bold"><a href="http://localhost:9080/docs/vim-mode">Vim Mode</a></li><ul class="pl-4"><li class="mb-2"><a href="http://localhost:9080/docs/vim-mode/actions">Actions</a></li></ul></ul></div><main class="flex-1 flex justify-center basis-7/7 col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30"><div class="flex-1 flex flex-col overflow-y-auto"><div class="flex-1 w-3/4 self-center p-8"><h1 class="my-3 font-bold text-4xl">Module bait</h1><i>the event emitter</i><h2 class="my-2 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Introduction">Introduction</h2><p>Bait is the event emitter for Hilbish. Much like Node.js and
its <code class="text-violet-600 dark:text-violet-400">events</code> system, many actions in Hilbish emit events.
Unlike Node.js, Hilbish events are global. So make sure to
pick a unique name!<br> <br>Usage of the Bait module consists of userstanding
event-driven architecture, but it&#39;s pretty simple:
If you want to act on a certain event, you can <code class="text-violet-600 dark:text-violet-400">catch</code> it.
You can act on events via callback functions.<br> <br>Examples of this are in the Hilbish default config!
Consider this part of it:</p><pre><code data-lang="lua">bait.catch(&#39;command.exit&#39;, function(code)
running = false
doPrompt(code ~= 0)
doNotifyPrompt()
end)
</code></pre><p>What this does is, whenever the <code class="text-violet-600 dark:text-violet-400">command.exit</code> event is thrown,
this function will set the user prompt.</p><h2 class="my-2 text-neutral-800 dark:text-neutral-300 font-bold text-3xl" id="Functions">Functions</h2><div><div class='relative overflow-x-auto sm:rounded-lg my-4'>
<table class='w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400'>
<tbody>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#catch">catch(name, cb)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Catches an event. This function can be used to act on events.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#catchOnce">catchOnce(name, cb)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Catches an event, but only once. This will remove the hook immediately after it runs for the first time.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#hooks">hooks(name) -> table</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Returns a table of functions that are hooked on an event with the corresponding `name`.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#release">release(name, catcher)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Removes the `catcher` for the event with `name`.</td>
</tr>
<tr class='bg-white border-b dark:bg-neutral-800 dark:border-neutral-700 border-neutral-200'>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'><a href="#throw">throw(name, ...args)</a></td>
<td class='p-3 font-medium text-black whitespace-nowrap dark:text-white'>Throws a hook with `name` with the provided `args`.</td>
</tr>
</tbody>
</table>
</div></div><h2 class="my-2 text-neutral-800 dark:text-neutral-300 font-bold text-3xl">Functions</h2><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='catch'>
<h4 class='text-xl font-medium mb-2'>
bait.catch(name, cb)
<a href="#catch" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
</div></div><p>Catches an event. This function can be used to act on events. </p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Parameters">Parameters</h4><p><code class="text-violet-600 dark:text-violet-400">string</code> <em>name</em>
The name of the hook.</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <em>cb</em>
The function that will be called when the hook is thrown.</p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Example">Example</h4><pre><code data-lang="lua">bait.catch(&#39;hilbish.exit&#39;, function()
print &#39;Goodbye Hilbish!&#39;
end)
</code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='catchOnce'>
<h4 class='text-xl font-medium mb-2'>
bait.catchOnce(name, cb)
<a href="#catchOnce" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
</div></div><p>Catches an event, but only once. This will remove the hook immediately after it runs for the first time. </p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</h4><p><code class="text-violet-600 dark:text-violet-400">string</code> <em>name</em>
The name of the event</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <em>cb</em>
The function that will be called when the event is thrown.</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='hooks'>
<h4 class='text-xl font-medium mb-2'>
bait.hooks(name) -> table
<a href="#hooks" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
</div></div><p>Returns a table of functions that are hooked on an event with the corresponding <code class="text-violet-600 dark:text-violet-400">name</code>. </p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</h4><p><code class="text-violet-600 dark:text-violet-400">string</code> <em>name</em>
The name of the hook</p><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='release'>
<h4 class='text-xl font-medium mb-2'>
bait.release(name, catcher)
<a href="#release" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
</div></div><p>Removes the <code class="text-violet-600 dark:text-violet-400">catcher</code> for the event with <code class="text-violet-600 dark:text-violet-400">name</code>.
For this to work, <code class="text-violet-600 dark:text-violet-400">catcher</code> has to be the same function used to catch
an event, like one saved to a variable. </p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</h4><p><code class="text-violet-600 dark:text-violet-400">string</code> <em>name</em>
Name of the event the hook is on</p><p><code class="text-violet-600 dark:text-violet-400">function</code> <em>catcher</em>
Hook function to remove</p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</h4><pre><code data-lang="lua">local hookCallback = function() print &#39;hi&#39; end
bait.catch(&#39;event&#39;, hookCallback)
-- a little while later....
bait.release(&#39;event&#39;, hookCallback)
-- and now hookCallback will no longer be ran for the event.
</code></pre><div><hr class='my-4 text-neutral-400 dark:text-neutral-600'>
<div id='throw'>
<h4 class='text-xl font-medium mb-2'>
bait.throw(name, ...args)
<a href="#throw" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
</div></div><p>Throws a hook with <code class="text-violet-600 dark:text-violet-400">name</code> with the provided <code class="text-violet-600 dark:text-violet-400">args</code>. </p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Parameters</h4><p><code class="text-violet-600 dark:text-violet-400">string</code> <em>name</em>
The name of the hook.</p><p><code class="text-violet-600 dark:text-violet-400">any</code> <em>args</em> (This type is variadic. You can pass an infinite amount of parameters with this type.)
The arguments to pass to the hook.</p><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Example</h4><pre><code data-lang="lua">bait.throw(&#39;greeting&#39;, &#39;world&#39;)
-- This can then be listened to via
bait.catch(&#39;gretting&#39;, function(greetTo)
print(&#39;Hello &#39; .. greetTo)
end)
</code></pre></div><footer class="py-4 px-6 flex flex-row justify-around border-t border-t-zinc-300"><div class="flex flex-col"><a class="flex items-center gap-1" href="http://localhost:9080"><img class="h-24" src="http://localhost:9080/hilbish-flower.png"><span class="self-center text-6xl">Hilbish</span></a><span class="text-xl">The Moon-powered shell!</span><span class="text-light text-neutral-500">MIT License, copyright sammyette 2025</span></div><div class="flex flex-col"><a href="https://github.com/Rosettea/Hilbish" target="_blank"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline"><tag><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6">
<path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25" />
</svg>
</tag>GitHub</span></a></div></footer></div></main></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink