Test::Deep::Type(3pm)

💖 Test::Deep::Type — the perl manual page, but make it a group chat 💖

okay bestie, so this is Test::Deep::Type, a User Contributed Perl Documentation page (that's the manual name right there, mwah 💅). It's a Test::Deep plugin, and it's about to be your new favorite thing, no cap.

---

✨ NAME ✨

Test::Deep::Type — a Test::Deep plugin for validating type constraints. it's giving "your data better be the right shape or we're gonna have a Conversation" 🫶

---

🌸 VERSION 🌸

version 0.008 — she's on 0.008, iconic behavior honestly

---

🎀 SYNOPSIS 🎀

look at this, look at her go:

use Test::More;
use Test::Deep;
use Test::Deep::Type;
use MooseX::Types::Moose 'Str';

cmp_deeply(
    {
        message => 'ack I am slain',
        counter => 123,
    },
    {
        message => is_type(Str),
        counter => is_type(sub { die "not an integer" unless int($_[0]) eq $_[0] }),
    },
    'message is a plain string, counter is a number',
);

like?? message is a plain string, counter is a number, and the test literally says so. obsessed. 💖

---

🦋 DESCRIPTION 🦋

so. this is a Test::Deep plugin that hands you the sub is_type, which is how you say "the data being tested MUST validate against the passed type" — emphasis on must, bestie, this is a vibe check with teeth.

important: this is an actual type object, not a string name. like, something you got from MooseX::Types, or a plain old coderef that returns a bool (the kind of thing you'd use in a Moo type constraint). actual object. not a string. i said what i said. ✨

---

💅 FUNCTIONS 💅

💜 is_type

Exported by default 🎁 — you're supposed to use her inside a Test::Deep comparison function like cmp_deeply.

And because this module is trying to be the solution for many popular type systems (she's a people pleaser, we love her for it), she tries to use the type in multiple ways:

MooseX::Types/Moose::Meta::TypeConstraint-style types

If the validate method exists, it gets invoked on the type object with the data as its parameter. and that should return undef on success, and the error message on failure. so basically: no news is good news, and bad news is a whole string. 🫶

coderef/Moo-style types

If the type appears to be or act like a coderef — and by that i mean either a coderef, blessed or unblessed, or it possesses a coderef overload — then the type gets invoked as a sub, with the data as its parameter.

Its return value is treated as a boolean 🔥. And if it also dies with a message describing the failure, that message gets used in the failure diagnostics. so when it goes wrong, you find out exactly how. slay.

Type::Tiny types fall into this category, and are fully supported. 💯

---

😭 CAVEATS 😭

Regular strings describing a type under a particular system (e.g. Moose, Params::Validate) are not currently supported. so don't come in here with a string name and expect the plugin to read your mind. she can't. not yet. 🙈

---

🌈 SEE ALSO 🌈

• Test::Deep
• Test::TypeConstraints
• Test::Type
• Test::Deep::Matcher
• MooseX::Types
• Moose::Meta::TypeConstraint
• Moo
• Type::Tiny

a whole friend group. iykyk 💅

---

🍓 SUPPORT 🍓

Bugs may be submitted through the RT bug tracker — that's <https://rt.cpan.org/Public/Dist/Display.html?Name=Test-Deep-Type> — or, if email is more your era, bug-Test-Deep-Type@rt.cpan.org <mailto:bug-Test-Deep-Type@rt.cpan.org>. tell them everything. 📩

There's also a mailing list available for users of this distribution, at <http://lists.perl.org/list/perl-qa.html>. join the list, bestie.

There's also an irc channel available for users of this distribution, at #perl on irc.perl.org <irc://irc.perl.org/#perl-qa>. come hang out. 🌸

And the author is also usually active on irc, as 'ether' at irc.perl.org. so like, she's there. say hi. 👑

---

👑 AUTHOR 👑

Karen Etheridge <ether@cpan.org> — mother is mothering

---

🧚 CONTRIBUTOR 🧚

Graham Knop <haarg@haarg.org> — thank you for your service 🫡

---

⭐ COPYRIGHT AND LICENCE ⭐

This software is copyright (c) 2013 by Karen Etheridge.

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 do whatever, just follow the Perl 5 terms. periodt. 💖

---

and that's the whole page, bestie 🎀 she was written for perl v5.34.0, dated 2022-06-17, and honestly? timeless. go validate some types. you're gonna eat. 💅✨