Perinci::Examples::ResultNaked - Demonstrate `result_naked` property
This document describes version 0.80 of Perinci::Examples::ResultNaked (from Perl distribution Perinci-Examples), released on 2017-07-11.
The functions in this package can test:
whether module POD is rendered correctly;
whether examples (in module POD or CLI help) are rendered correctly;
Usage:
result_naked(%args) -> any
This function does not return enveloped result.
Examples:
Without the optional arg3:
result_naked(arg1 => "abc", arg2 => 10); # -> ["arg1", "abc", "arg2", 10]
With the optional arg3:
result_naked(arg1 => "def", arg2 => 20, arg3 => 0.5); # -> ["arg3", 0.5, "arg1", "def", "arg2", 20]
This function is not exported.
Arguments ('*' denotes required arguments):
arg1* => str
arg2* => int
arg3 => float
Return value: (any)
result_not_naked(%args) -> [status, msg, result, meta]
This is the default.
result_not_naked(arg1 => "abc", arg2 => 10); # -> [200, "OK", ["arg2", 10, "arg1", "abc"], {}]
result_not_naked(arg1 => "def", arg2 => 20, arg3 => 0.5);
Result:
[200, "OK", ["arg3", 0.5, "arg1", "def", "arg2", 20], {}]
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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Please visit the project's homepage at https://metacpan.org/release/Perinci-Examples.
Source repository is at https://github.com/perlancar/perl-Perinci-Examples.
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 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.
To install Perinci::Examples, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::Examples
CPAN shell
perl -MCPAN -e shell install Perinci::Examples
For more information on module installation, please visit the detailed CPAN module installation guide.