Type::P...arameter(3)

📦
version 2.010001 · 6 versions
, in alpine 3.24

🌟 Type::Params::Parameter 🌟

okay so bestie, welcome to the User Contributed Perl Documentation page for Type::Params::Parameter — yes, that Type::Params::Parameter. ✨ it’s giving internal-signature-representation realness, and we’re gonna get into it.

🦋 NAME 🦋

Type::Params::Parameter — internal representation of a parameter in a function signature. no cap. 💅

🚨 STATUS 🚨

this module is not covered by the Type-Tiny stability policy. periodt.

🌈 DESCRIPTION 🌈

This is mostly internal code, but it can be used to provide basic introspection for signatures. lowkey useful for peeking at signatures, bestie. 👀

🎀 Constructor 🎀

new(%attributes) — that’s the constructor. that’s it, that’s the constructor. 💖

💅 Attributes 💅

All attributes are read-only. no touching, bestie.

  • type (TypeTiny) — type constraint for the parameter.
  • default (CodeRef|ScalarRef|Ref|Str|Undef) — a default for the parameter: either a coderef to generate a value, a reference to a string of Perl code to generate the value, a reference to an empty array or empty hash, a literal string to use as a default, or a literal undef to use as a default.
  • strictness (Bool|ScalarRef) — a boolean indicating whether to be stricter with type checks, or a reference to a string of Perl code naming a Perl variable or constant which controls strict behaviour.
  • clone (Bool) — the method for accessing this is called should_clone for no particular reason.
  • coerce (Bool) — defaults to true if type has a coercion.
  • optional (Bool) — defaults to true if there is a default or if type is a subtype of Optional.
  • in_list (Bool) — boolean that is only used when the signature has the list_to_named feature enabled.
  • default_on_undef (Bool) — should the default be triggered if the caller passes an explicit undef?
  • name (Str)
  • alias (ArrayRef[Str])
  • getter (Str)
  • predicate (Str)

🌸 Methods 🌸

💖 Predicates 💖

Predicate methods return true/false to indicate the presence or absence of attributes.

  • has_type — presence check for type.
  • has_default — presence check for default.
  • has_strictness — presence check for strictness.
  • has_name — presence check for name.
  • has_alias — presence check for alias.

🦋 Other methods 🦋

  • might_supply_new_value — indicates that the parameter can’t simply be referenced within @_ because a default value might be used, the given value might be coerced, or the given value might be cloned using Storable.

🐛 BUGS 🐛

bestie, if something’s busted, please report any bugs to https://github.com/tobyink/p5-type-tiny/issues.

👀 SEE ALSO 👀

  • Type::Params
  • Type::Params::Signature

👑 AUTHOR 👑

Toby Inkster <tobyink@cpan.org>.

This software is copyright (c) 2023-2025 by Toby Inkster.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

⚠️ DISCLAIMER OF WARRANTIES ⚠️

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
🫶 okay that’s the whole page, bestie! this little icon is from perl v5.42.2, dated 2026-04-07, and the title on the tin is Type::P...arameter(3). mwah! 💋
📦 where this page comes from