sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-05-06 04:13:24 +00:00
Code Issues Releases Wiki Activity
Hilbish/versions/new-website/docs/api/hilbish/hilbish.timers/index.html

114 lines
7.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html class="bg-stone-50 dark:bg-neutral-950 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="./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="https://rosettea.github.io/Hilbish/versions/new-website" property="og:url"></head><body><nav class="flex sticky 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-6" src="/hilbish-flower.png"><span class="self-center text-2xl">Hilbish</span></a></div></div></nav><div class="flex flex-col"><div class="block sm:hidden h-10 sticky top-12 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 z-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-black"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span>Module hilbish.timers</span></div><div class="grid sm:flex"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="border-r border-r-zinc-300 col-start-1 row-start-1 sticky top-22 sm:top-12 h-full sm:h-svh bg-neutral-200 basis-3/5 transition-transform duration-300 -translate-x-full sm:translate-x-0 peer-checked:translate-x-0 z-30"><div class="p-4 -mb-4 overflow-y-auto h-full"><h2 class="text-xl font-semibold mb-4">Sidebar</h2><ul><li class="mb-2">Lunacolors</li><li class="mb-2">Introduction</li><li class="mb-2">Completions</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Options</li><li class="mb-2">Features</li><li class="mb-2">Runner Mode</li><li class="mb-2">Notification</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Command</li><li class="mb-2">Hilbish</li><li class="mb-2">Vim Mode</li><li class="mb-2">Actions</li><li class="mb-2">Module bait</li><li class="mb-2">Module terminal</li><li class="mb-2">API</li><li class="mb-2">Module fs</li><li class="mb-2">Module commander</li><li class="mb-2">Module snail</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module dirs</li><li class="mb-2">Nature</li><li class="mb-2">Module doc</li></ul></div></div><main class="col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30 px-4 pt-2"><h1>Module hilbish.timers</h1><Tag xmlns="namespace"><h2>Introduction</h2>
<p>If you ever want to run a piece of code on a timed interval, or want to wait
a few seconds, you don’t have to rely on timing tricks, as Hilbish has a
timer API to set intervals and timeouts.</p>
<p>These are the simple functions <code>hilbish.interval</code> and <code>hilbish.timeout</code> (doc
accessible with <code>doc hilbish</code>, or <code>Module hilbish</code> on the Website).</p>
<p>An example of usage:</p>
<pre><code><span><span>local</span> <span>t</span> <span>=</span> <span>hilbish</span><span>.</span><span>timers</span><span>.</span><span>create</span><span>(</span><span>hilbish</span><span>.</span><span>timers</span><span>.</span><span>TIMEOUT</span><span>,</span> <span>5000</span><span>,</span> <span>function</span><span>(</span><span>)</span>
</span><span> <span>print</span> <span>'hello!'</span>
</span><span><span>end</span><span>)</span>
</span><span>
</span><span><span>t</span><span>:</span><span>start</span><span>(</span><span>)</span>
</span><span><span>print</span><span>(</span><span>t</span><span>.</span><span>running</span><span>)</span> <span>//</span> <span>true</span>
</span></code></pre>
<h2>Functions</h2>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="#timers.create" rel="noopener noreferrer">create(type, time, callback) -&gt; @Timer</a></td>
<td>Creates a timer that runs based on the specified <code>time</code>.</td>
</tr>
<tr>
<td><a href="#timers.get" rel="noopener noreferrer">get(id) -&gt; @Timer</a></td>
<td>Retrieves a timer via its ID.</td>
</tr>
</tbody>
</table>
<h2>Static module fields</h2>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>INTERVAL</td>
<td>Constant for an interval timer type</td>
</tr>
<tr>
<td>TIMEOUT</td>
<td>Constant for a timeout timer type</td>
</tr>
</tbody>
</table>
<hr>
<div>
<h4>
hilbish.timers.create(type, time, callback) -&gt; <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" rel="noopener noreferrer">Timer</a>
<a href="#timers.create" rel="noopener noreferrer">
<i></i>
</a>
</h4>
<p>Creates a timer that runs based on the specified <code>time</code>.</p>
<h4>Parameters</h4>
<p><code>number</code> <strong><code>type</code></strong><br>
What kind of timer to create, can either be <code>hilbish.timers.INTERVAL</code> or <code>hilbish.timers.TIMEOUT</code></p>
<p><code>number</code> <strong><code>time</code></strong><br>
The amount of time the function should run in milliseconds.</p>
<p><code>function</code> <strong><code>callback</code></strong><br>
The function to run for the timer.</p>
</div>
<hr>
<div>
<h4>
hilbish.timers.get(id) -&gt; <a href="/Hilbish/docs/api/hilbish/hilbish.timers/#timer" rel="noopener noreferrer">Timer</a>
<a href="#timers.get" rel="noopener noreferrer">
<i></i>
</a>
</h4>
<p>Retrieves a timer via its ID.</p>
<h4>Parameters</h4>
<p><code>number</code> <strong><code>id</code></strong></p>
</div>
<h2>Types</h2>
<hr>
<h2>Timer</h2>
<p>The Job type describes a Hilbish timer.</p>
<h2>Object properties</h2>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>What type of timer it is</td>
</tr>
<tr>
<td>running</td>
<td>If the timer is running</td>
</tr>
<tr>
<td>duration</td>
<td>The duration in milliseconds that the timer will run</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<h4>start()</h4>
<p>Starts a timer.</p>
<h4>stop()</h4>
<p>Stops a timer.</p></Tag></main></div></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="/"><img class="h-24" src="/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"><span class="text-pink-300 text-light">GitHub</span></a></div></footer></body></html>
Reference in New Issue View Git Blame Copy Permalink