{
    "mode": "perldoc",
    "parameter": "Type::Tiny::Union",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Type%3A%3ATiny%3A%3AUnion/json",
    "generated": "2026-10-04T18:48:46Z",
    "synopsis": "Using via the \"|\" operator overload:\npackage Local::Stash {\nuse Moo;\nuse Types::Common qw( ArrayRef HashRef );\nhas data => (\nis   => 'ro',\nisa  => HashRef | ArrayRef,\n);\n}\nmy $x = Local::Stash->new( data => {} );  # ok\nmy $y = Local::Stash->new( data => [] );  # ok\nUsing Type::Tiny::Union's object-oriented interface:\npackage Local::Stash {\nuse Moo;\nuse Types::Common qw( ArrayRef HashRef );\nuse Type::Tiny::Union;\nmy $AnyData = Type::Tiny::Union->new(\nname             => 'AnyData',\ntypeconstraints => [ HashRef, ArrayRef ],\n);\nhas data => (\nis   => 'ro',\nisa  => $AnyData,\n);\n}\nUsing Type::Utils's functional interface:\npackage Local::Stash {\nuse Moo;\nuse Types::Common qw( ArrayRef HashRef );\nuse Type::Utils;\nmy $AnyData = union AnyData => [ HashRef, ArrayRef ];\nhas data => (\nis   => 'ro',\nisa  => $AnyData,\n);\n}",
    "sections": {
        "NAME": {
            "content": "Type::Tiny::Union - union type constraints\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "Using via the \"|\" operator overload:\n\npackage Local::Stash {\nuse Moo;\nuse Types::Common qw( ArrayRef HashRef );\n\nhas data => (\nis   => 'ro',\nisa  => HashRef | ArrayRef,\n);\n}\n\nmy $x = Local::Stash->new( data => {} );  # ok\nmy $y = Local::Stash->new( data => [] );  # ok\n\nUsing Type::Tiny::Union's object-oriented interface:\n\npackage Local::Stash {\nuse Moo;\nuse Types::Common qw( ArrayRef HashRef );\nuse Type::Tiny::Union;\n\nmy $AnyData = Type::Tiny::Union->new(\nname             => 'AnyData',\ntypeconstraints => [ HashRef, ArrayRef ],\n);\n\nhas data => (\nis   => 'ro',\nisa  => $AnyData,\n);\n}\n\nUsing Type::Utils's functional interface:\n\npackage Local::Stash {\nuse Moo;\nuse Types::Common qw( ArrayRef HashRef );\nuse Type::Utils;\n\nmy $AnyData = union AnyData => [ HashRef, ArrayRef ];\n\nhas data => (\nis   => 'ro',\nisa  => $AnyData,\n);\n}\n",
            "subsections": []
        },
        "STATUS": {
            "content": "This module is covered by the Type-Tiny stability policy.\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Union type constraints.\n\nThis package inherits from Type::Tiny; see that for most documentation. Major differences are\nlisted below:\n",
            "subsections": [
                {
                    "name": "Constructor",
                    "content": "The \"new\" constructor from Type::Tiny still works, of course. But there is also:\n"
                },
                {
                    "name": "new_by_overload",
                    "content": "Like the \"new\" constructor, but will sometimes return another type constraint which is not\nstrictly an instance of Type::Tiny::Union, but still encapsulates the same meaning. This\nconstructor is used by Type::Tiny's overloading of the \"|\" operator.\n"
                },
                {
                    "name": "Attributes",
                    "content": "\"typeconstraints\"\nArrayref of type constraints.\n\nWhen passed to the constructor, if any of the type constraints in the union is itself a\nunion type constraint, this is \"exploded\" into the new union.\n\n\"constraint\"\nUnlike Type::Tiny, you *cannot* pass a constraint coderef to the constructor. Instead rely\non the default.\n\n\"inlined\"\nUnlike Type::Tiny, you *cannot* pass an inlining coderef to the constructor. Instead rely on\nthe default.\n\n\"parent\"\nUnlike Type::Tiny, you *cannot* pass an inlining coderef to the constructor. A parent will\ninstead be automatically calculated.\n\n\"coercion\"\nYou probably do not pass this to the constructor. (It's not currently disallowed, as there\nmay be a use for it that I haven't thought of.)\n\nThe auto-generated default will be a Type::Coercion::Union object.\n"
                },
                {
                    "name": "Methods",
                    "content": ""
                },
                {
                    "name": "find_type_for",
                    "content": "Returns the first individual type constraint in the union which $value passes.\n"
                },
                {
                    "name": "stringifies_to",
                    "content": "See Type::Tiny::ConstrainedObject.\n"
                },
                {
                    "name": "numifies_to",
                    "content": "See Type::Tiny::ConstrainedObject.\n\n\"withattributevalues($attr1 => $constraint1, ...)\"\nSee Type::Tiny::ConstrainedObject.\n"
                },
                {
                    "name": "Overloading",
                    "content": "*   Arrayrefification calls \"typeconstraints\".\n"
                }
            ]
        },
        "BUGS": {
            "content": "Please report any bugs to <https://github.com/tobyink/p5-type-tiny/issues>.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "Type::Tiny::Manual.\n\nType::Tiny.\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Toby Inkster <tobyink@cpan.org>.\n",
            "subsections": []
        },
        "COPYRIGHT AND LICENCE": {
            "content": "This software is copyright (c) 2013-2014, 2017-2023 by Toby Inkster.\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the Perl\n5 programming language system itself.\n",
            "subsections": []
        },
        "DISCLAIMER OF WARRANTIES": {
            "content": "THIS PACKAGE IS PROVIDED \"AS IS\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\nWITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR\nPURPOSE.\n",
            "subsections": []
        }
    },
    "summary": "Type::Tiny::Union - union type constraints",
    "flags": [],
    "examples": [],
    "see_also": []
}