.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" ======================================================================== .\" .IX Title "GraphQL::MaybeTypeCheck 3pm" .TH GraphQL::MaybeTypeCheck 3pm "2022-03-27" "perl v5.34.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" GraphQL::MaybeTypeCheck \- Conditional type\-checking at runtime .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use GraphQL::MaybeTypeCheck; \& \& method foo( \& $arg1 Str, \& $arg2 Int \& ) :ReturnType(Map[Str, Int]) { \& # ... \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module \fBoptionally\fR enables type-checking in the caller as implemented by Function::Parameters and Return::Type depending on whether Devel::StrictMode is activated. .PP \fI\f(CI\*(C`Devel::StrictMode\*(C'\fI \s-1ON\s0\fR .IX Subsection "Devel::StrictMode ON" .PP When Devel::StrictMode is active, this module will import Function::Parameters into the caller with its default configuration. As of writing, this includes checking both argument count and type. .PP When in strict mode this also \f(CW\*(C`require\*(C'\fRs Return::Type which registers the \&\f(CW\*(C`ReturnType\*(C'\fR attribute. .PP \fI\f(CI\*(C`Devel::StrictMode\*(C'\fI \s-1OFF\s0\fR .IX Subsection "Devel::StrictMode OFF" .PP When strict mode is inactive this module still imports \f(CW\*(C`Function::Parameters\*(C'\fR into the caller however it sets \f(CW\*(C`fun\*(C'\fR and \f(CW\*(C`method\*(C'\fR to lax mode and disables argument type checking. .PP This also installs a no-op \f(CW\*(C`ReturnType\*(C'\fR attribute so the existing syntax isn't broken.