.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Type::Params::Alternatives 3"
.TH Type::Params::Alternatives 3 2025-07-14 "perl v5.42.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Type::Params::Alternatives \- subclass of Type::Params::Signature for "multi" signatures
.SH STATUS
.IX Header "STATUS"
This module is not covered by the
Type\-Tiny stability policy.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is mostly internal code, but can be used to provide basic introspection
for signatures.
.PP
This module is a subclass of Type::Parameters::Signature, so inherits
attributes and methods from that.
.SS Constructor
.IX Subsection "Constructor"
.ie n .IP new(%attributes) 4
.el .IP \f(CWnew(%attributes)\fR 4
.IX Item "new(%attributes)"
.SS Attributes
.IX Subsection "Attributes"
All attributes are read\-only.
.ie n .IP """base_options"" \fBHashRef\fR" 4
.el .IP "\f(CWbase_options\fR \fBHashRef\fR" 4
.IX Item "base_options HashRef"
.PD 0
.ie n .IP """alternatives"" \fBArrayRef[HashRef|ArrayRef|CodeRef]\fR" 4
.el .IP "\f(CWalternatives\fR \fBArrayRef[HashRef|ArrayRef|CodeRef]\fR" 4
.IX Item "alternatives ArrayRef[HashRef|ArrayRef|CodeRef]"
.ie n .IP """sig_class"" \fBClassName\fR" 4
.el .IP "\f(CWsig_class\fR \fBClassName\fR" 4
.IX Item "sig_class ClassName"
.ie n .IP """meta_alternatives"" \fBArrayRef[HashRef]\fR" 4
.el .IP "\f(CWmeta_alternatives\fR \fBArrayRef[HashRef]\fR" 4
.IX Item "meta_alternatives ArrayRef[HashRef]"
.PD
Automatically built from \f(CW\*(C`alternatives\*(C'\fR; do not set this yourself.
.ie n .IP """parameters"" \fBArrayRef\fR" 4
.el .IP "\f(CWparameters\fR \fBArrayRef\fR" 4
.IX Item "parameters ArrayRef"
Overridden from parent class to always return the empty arrayref.
.ie n .IP """message"" \fBStr\fR" 4
.el .IP "\f(CWmessage\fR \fBStr\fR" 4
.IX Item "message Str"
Error message to be thrown when none of the alternatives match.
This is a bare attribute with no accessor method.
.SH BUGS
.IX Header "BUGS"
Please report any bugs to
<https://github.com/tobyink/p5\-type\-tiny/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Type::Params, Type::Params::Signature.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2023\-2025 by Toby Inkster.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "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.