SHTK_BOOL_CHECK(3)

💖 SHTK_BOOL_CHECK(3) 💖

okay so bestie, welcome to the shtk_bool_check page — it's a library function from the shtk manual, section 3, and it's literally about turning a string into a boolean. no cap, it's simpler than it sounds. 🦋

🌸 LIBRARY 🌸

shtk_import bool

like, you gotta import it first, obviously. 💅

✨ SYNOPSIS ✨

shtk_bool_check value [error_message]

🎀 DESCRIPTION 🎀

so the shtk_bool_check function takes the string value and returns the corresponding boolean value according to shell conventions. that's it. that's the whole vibe. ✨

⭐ RETURN VALUES ⭐

• shtk_bool_check returns 0 for any value representing truth. these include the strings ‘yes’ and ‘true’, including any variations in their capitalization, and the integer number ‘1’. slay. 👑
• shtk_bool_check returns 1 for any value representing falsehood. these include the strings ‘no’ and ‘false’, including any variations in their capitalization, and the integer number ‘0’. periodt. 💀

🌈 EXAMPLES 🌈

local verbose=no
# Parse flags to see if verbose mode is enabled and set verbose=yes.

if shtk_bool_check "${verbose}"; then
    # Print messages.
fi

like, see how it's used? it's giving "clean little conditional" and we're obsessed. 🫶

💜 ERRORS 💜

shtk_bool_check prints the error given in error_message and exits the shell with non-zero if the value does not represent a valid boolean value. and if error_message is not provided, a default message is printed. so yeah — pass your message or get the default one, either way you're covered. 🙈

🦋 SEE ALSO 🦋

• shtk(3)
• shtk_bool(3)

🍓 HISTORY 🍓

shtk_bool_check first appeared in shtk 1.4. iconic behavior, honestly. ⭐

---

and that's the whole page, bestie 💖 this beauty comes from Debian, dated November 5, 2014 — go forth and boolean-check responsibly. 🌸💅