NAME
Perinci::Examples::Tiny::Args - Tests related to function arguments
VERSION
This document describes version 0.819 of Perinci::Examples::Tiny::Args (from Perl distribution Perinci-Examples), released on 2019-08-14.
DESCRIPTION
Like the other Perinci::Examples::Tiny::*, this module does not use other modules and is suitable for testing Perinci::CmdLine::Inline as well as other Perinci::CmdLine frameworks.
FUNCTIONS
as_is
Usage:
as_is(%args) -> [status, msg, payload, meta]This function returns the argument as-is.
This function is not exported.
Arguments ('*' denotes required arguments):
arg => any
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
has_date_and_duration_args
Usage:
has_date_and_duration_args(%args) -> [status, msg, payload, meta]This function contains a date and a duration argument.
This function is not exported.
Arguments ('*' denotes required arguments):
date* => date
duration* => duration
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
has_date_arg
Usage:
has_date_arg(%args) -> [status, msg, payload, meta]This function contains a date argument.
This function is not exported.
Arguments ('*' denotes required arguments):
date* => date
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
has_dot_args
Usage:
has_dot_args(%args) -> [status, msg, payload, meta]This function contains arguments with dot in their names.
This function is not exported.
Arguments ('*' denotes required arguments):
a.number* => int
another.number* => float
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: Return the two numbers multiplied (any)
has_duration_arg
Usage:
has_duration_arg(%args) -> [status, msg, payload, meta]This function contains a duration argument.
This function is not exported.
Arguments ('*' denotes required arguments):
duration* => duration
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Perinci-Examples.
SOURCE
Source repository is at https://github.com/perlancar/perl-Perinci-Examples.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Examples
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.