Test::...ception(3pm)

📦
version 2.12 · 6 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

👑 Test::...ception(3pm) — the perl module manual page, bestie 🎀

okay so before we even get into it: this is the Test::...ception(3pm) man page, which is the Perl module documentation section (the 3pm part, iykyk). it's not the full name, it's the truncated one, because man pages are extra like that. and the whole thing is Test::Timer::TimeoutException, so buckle up.

✨ NAME ✨

Test::Timer::TimeoutException — the exception class for Test::Timer. that's it, that's the whole job. she's the one who shows up when time runs out. 💅

🌸 VERSION 🌸

this documentation describes 2.12 of Test::Timer::TimeoutException. so if you're on some other version, girl, this page might not be talking to you. 🙈

🦋 SYNOPSIS 🦋

here's the vibe, literally:

use Test::Timer::TimeoutException;

throw Test::Timer::TimeoutException($timeout);

that's the whole thing. use it, then throw it with your $timeout. no drama. ✨

💖 DESCRIPTION 💖

so this is an exception class for Test::Timer. it works in conjunction with the alarm signal — and she gets thrown if the alarm is set off. so when the clock goes off, she goes off. iconic behaviour honestly. ⏰🔥

🧚 SUBROUTINES/METHODS 🧚

🎀 new

this is the constructor. it gets called using throw, so like — please refer to the documentation for Error, and also peek the SYNOPSIS above if you need a visual. you don't call new directly here, bestie, throw does it for you. 🫶

⭐ DIAGNOSTICS ⭐

it's an exception class, so it holds no special diagnostics apart from what's already described above in the general description. nothing extra hiding in here. she's lowkey minimal. 💀

🌈 CONFIGURATION AND ENVIRONMENT 🌈

this module requires no special configuration or environment. zero setup, zero env vars, nothing to export, nothing to tweak. just vibes. 🍓

💜 DEPENDENCIES 💜

  • Error

that's the whole list. one (1) dependency. main character energy. 👑

✨ INCOMPATIBILITIES ✨

this class holds no known incompatibilities. she plays nice with everybody. 🎀

💅 BUGS AND LIMITATIONS 💅

this class holds no known bugs or limitations. no cap. (which is either a flex or a challenge, and honestly both. 😭)

🔥 TEST AND QUALITY 🔥

this class is tested as part of Test::Timer. so the test coverage she has, she has through her parent module. 🌸

🫶 SEE ALSO 🫶

  • Test::Timer

👑 AUTHOR 👑

  • Jonas B. Nielsen (jonasbn) "<jonasbn at cpan.org>"

Test::Timer and related modules are (C) by Jonas B. Nielsen, (jonasbn) 2007-2017

Test::Timer and related modules are released under the Artistic License 2.0

Used distributions are under copyright of there respective authors and designated licenses

Image used on website https://jonasbn.github.io/perl-test-timer/ is under copyright by Veri Ivanova https://unsplash.com/@veri_ivanova?photo=p3Pj7jOYvnM

shoutout to the whole Test::Timer family for keeping it real since 2007. 🫡

and that's a wrap! this page was riding with perl v5.36.0 and dated 2022-10-13, so if you're reading this in the group chat, tell the perl version and the date you heard it from me. slay, go write some tests, bye bestie 💖✨🎀🦋

📦 where this page comes from