luastatu...in-timer(7)

🌸 NAME 🌸

luastatus-plugin-timer — timer plugin for luastatus. You're reading the luastatu...in-timer(7) page, bestie, and yes, she's iconic 💅

---

✨ OVERVIEW ✨

Okay so this plugin is literally a simple timer, and you can also specify a wake-up FIFO. Cute, right? 🎀

---

🌈 OPTIONS 🌈

The following options are supported:

• period: number — a number of seconds to sleep before calling cb again. May be fractional. Defaults to 1. ⏰
• fifo: string — path to an existent FIFO. The plugin does not create the FIFO itself. To force a wake-up, touch(1) the FIFO, that is, open it for writing and then close. 🫶

---

💬 CB ARGUMENT 💬

A string describing why the function is called:

• if it is "hello", the function is called for the first time; 👋
• if it is "timeout", the function hasn't been called for period seconds; ⏳
• if it is "fifo", the FIFO has been touched. 🦋

---

🧚 FUNCTIONS 🧚

The following functions are provided:

• push_period(seconds) — changes the timer period for one iteration. ✨

---

👑 COPYRIGHT 👑

LGPLv3 💜

---

Final footer flex: luastatu...in-timer(7) — mwah, bye bestie 🌈💖