Pod::R...:Types(3pm)

💖 Pod::Readme::Types — the vibe check on types 💖

Bestie. This is Pod::Readme::Types, a lil corner of the User Contributed Perl Documentation universe. It's the type library that the Pod::Readme family leans on, and today we're getting into every single one of them. No skips, no skimming, we're reading the whole thing. ✨

---

🌸 NAME 🌸

Pod::Readme::Types — the types used by Pod::Readme, periodt. 💅

---

✨ SYNOPSIS ✨

Okay so here's the whole vibe in code form, and yes it's giving exactly what it needs to give:

use Pod::Readme::Types qw/ Indentation /;

has verbatim_indent => (
  is      => 'ro',
  isa     => Indentation,
  default => 2,
);

Look at that. Clean. Cozy. <cyan>Indentation</cyan> doing its little job. We love to see it. 🫶

---

🦋 DESCRIPTION 🦋

So this module provides types for use with the modules in Pod::Readme. That's the whole gig.

Now, lowkey important: it is intended for internal use. It's not out here trying to be your main character API. However — and this is the fun part — some of these may be useful for writing plugins (see Pod::Readme::Plugin). So if you're out here building a plugin, peek at these, they might eat. 🔥

---

🎀 EXPORTS 🎀

None by default. Not a single one, babe, it's giving empty-handed on arrival. All functions must be explicitly exported. So you gotta ask nicely — qw/ ... / — or you get nothing. That's the deal. 🙈

💜 "Indentation"

The indentation level used for verbatim text. Must be an integer greater than or equal to 2.

So like, 2? Slay. 1? Absolutely not, bestie. 😭

💜 "HeadingLevel"

A heading level, used for plugin headings.

Must be either 1, 2 or 3. And heads up (pun intended, I'm hilarious): note that =head4 is not allowed, since some plugins use subheadings. So 4 is out. Blocked. Not invited to the function. 💀

💜 "TargetName"

A name of a target, e.g. "readme". Simple as that. Cute, short, iconic. ⭐

💜 "Dir"

A directory. Can be a string or Path::Tiny object. Flexible queen. 🌈

💜 "File"

A file. Can be a string or Path::Tiny object. Same energy, different noun. 🍓

💜 "IO"

An IO::Handle or IO::String object. That's it, that's the type. 🧚

💜 "ReadIO" / "WriteIO"

These are IO types, which coerce filehandles to read/write IO::Handles, respectively. So ReadIO handles the reading side, WriteIO handles the writing side. Each one doing its own lil thing. Obsessed. 💖

---

Quick reminder bestie: nothing here is exported unless you explicitly ask for it. Don't come for me later like "where are my types" — you gotta use them by name. iykyk. 💅

---

And that's the whole page, fr fr. This was written by the Perl crew, shipped as part of perl v5.28.0 on 2018-11-26, under the User Contributed Perl Documentation umbrella. 💖 Stay typed, stay iconic, and go write that plugin. Mwah. ✨🎀🦋