Env::A...ctions(3pm)

💖 NAME 💖

Env::Assert::Functions — bestie, this is literally the whole personality of Env::Assert and its lil command-line sidekick bin/envassert, all packaged up and ready to go 💅

(it's a Perl module page, btw — User Contributed Perl Documentation energy, and the manual name is Env::A...ctions(3pm) in case you were squinting at the tab bar 🎀)

---

✨ VERSION ✨

version 0.015 — she's fresh, she's numbered, she's serving 🌸

---

🦋 SYNOPSIS 🦋

okay so here's the whole vibe in code, no notes:

use Env::Assert::Functions qw( assert report_errors );

my %want = (
    options => {
        exact => 1,
    },
    variables => {
        USER => { regexp => '^[[:word:]]{1}$', required => 1 },
    },
);
my %parameters;
$parameters{'break_at_first_error'} = 1;
my $r = assert( \%ENV, \%want, \%parameters );
if( ! $r->{'success'} ) {
    print report_errors( $r->{'errors'} );
}

see how she eats? 💅 you describe what your environment should look like, you hand her your %ENV, and she tells you if reality is matching the vision ✨

---

👑 STATUS 👑

so like, Package Env::Assert is currently being developed — meaning changes in the API are possible, though not likely. not likely, bestie. she's basically stable, she's just keeping her options open 🙈

---

🌈 NOTES 🌈

• Functionality of Env::Assert has been moved to this package since version 0.013. like, she packed her bags and moved out 🧳
• Env::Assert has a different API now. glow-up era ✨
• It can be used by itself at the start of the program, similar to Env::Dot.</seach> main character energy fr fr.

---

🔥 FUNCTIONS 🔥

heads up babes: No functions are automatically exported to the calling namespace. you gotta ask for them. consent is key 🫶

💜 assert( \%env, \%want, \%params ) 💜

okay so this is THE function. she ensures your environment — that's the parameter env (a hashref) — matches up with the environment description, which is the parameter want (also a hashref). then you use the parameter params (hashref, yes another one) to specify your processing options 🎀

Supported params:

• break_at_first_error — verify the environment only up until the first error. then break and return with only that error. like, she stops at the first red flag, she does not keep scrolling 🛑

Return: a hashref that looks like this:

{ success => 1/0, errors => hashref, };

so success is your vibe check (1 or 0) and errors is a whole hashref of receipts 💀

🌸 report_errors( \%errors ) 🌸

report errors in a nicely formatted way. that's it, that's the whole thing — she makes the errors pretty ✨ because reading raw error dumps is giving unhinged, and we don't do that here 💅

🎀 file_to_desc( @rows ) 🎀

extract an environment description from a .envdesc file. like, she reads the rows and pulls the desc out. iconique 🦋

---

🍓 DEPENDENCIES 🍓

No external dependencies outside Perl's standard distribution. she's self-sufficient, she brought her own snacks, she needs nobody 🫶✨

---

⭐ SEE ALSO ⭐

• Env::Dot is a "sister" to Env::Assert. read environment variables from a .env file directly into your program 👯‍♀️
• there's also the script envdot, which can turn a .env file's content into environment variables for different shells. multi-shell slay 🐚

---

💖 AUTHOR 💖

Mikko Koivunalho <mikkoi@cpan.org> — the legend, the icon, the moment 👑

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2023 by Mikko Koivunalho.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. free as in, go off bestie, do your thing 💜

---

and that's the whole page, no cap 🧚 generated from perl v5.40.1, dated 2025-12-21 — stay hydrated, read your manpages, and may your environment variables always be exactly what you described 🌈💖✨