List::...::Typed(3pm)

✨ NAME ✨

List::Objects::WithUtils::Role::Hash::Typed — it's the type-checking hash behavior role, bestie 💅 (it lives in the List::...::Typed(3pm) manual, iykyk)

---

🌸 SYNOPSIS 🌸

# Via List::Objects::WithUtils::Hash::Typed ->
use List::Objects::WithUtils 'hash_of';
use Types::Standard -all;

my $arr = hash_of(Int, foo => 1, bar => 2);
$arr->set(baz => 3.14159);    # dies, failed type check

---

💖 DESCRIPTION 💖

Okay so this role is literally the vibe check for your hashes 🫶. It uses Type::Tie to bolt type-checking behavior onto anyone consuming List::Objects::WithUtils::Role::Hash. No cap.

The first argument you pass to the constructor should be a Type::Tiny type — or any other object conforming to Type::API, as of "v2.25" ⭐:

use Types::Standard -all;
my $arr = hash_of ArrayRef() => (foo => [], bar => []);

Values get checked against the type you specified when the object is constructed or when new elements get added. Every single time. She's watching 👀.

If that initial type-check fails, a coercion is attempted. Girl tries her best.

Values that cannot be coerced will throw an exception 💀 so like, don't try it.

Also see Types::Standard, List::Objects::Types — they're the friends of the family 🌈.

---

🦋 type 🦋

Returns the Type::Tiny type the object was created with. Just hands you the receipts, periodt.

---

🎀 untyped 🎀

Returns a (shallow) clone that is a plain List::Objects::WithUtils::Hash. She took off the sparkle and went au naturel ✨.

---

👑 AUTHOR 👑

Jon Portnoy <avenj@cobaltirc.org>; typed hashes implemented by Toby Inkster (CPAN: TOBYINK) 🫡

---

and that's the whole page, bestie 💜 — this lil gem is from perl v5.38.2, dated 2024-03-07, and it lives in the List::...::Typed(3pm) manual under User Contributed Perl Documentation. slay, go type-check something 🌟