/ 
Perinci-Examples-0.819
River stage three • 21 direct dependents • 573 total dependents
/ Perinci::Examples::rimetadb::IncludedPackage

NAME

Perinci::Examples::rimetadb::IncludedPackage - Example of included package

VERSION

This document describes version 0.819 of Perinci::Examples::rimetadb::IncludedPackage (from Perl distribution Perinci-Examples), released on 2019-08-14.

DESCRIPTION

This package should be imported to database because of there is no attribute:

x.app.rimetadb.exclude => 1

FUNCTIONS

func1

Usage:

func1() -> [status, msg, payload, meta]

A sample function.

This function is included because the metadata does not have this attribute:

x.app.rimetadb.exclude => 1

This function is not exported.

No arguments.

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)

func2

Usage:

func2() -> [status, msg, payload, meta]

A sample function.

This function is excluded because the metadata has this attribute:

x.app.rimetadb.exclude => 1

This function is not exported.

No arguments.

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)

func3

Usage:

func3(%args) -> [status, msg, payload, meta]

A sample function.

This function is included because the metadata does not have this attribute:

x.app.rimetadb.exclude => 1

but some of its arguments are excluded because the argument specification has the abovementioned attribute.

This function is not exported.

Arguments ('*' denotes required arguments):

  • arg1* => int

    This argument is included.

  • arg2 => int

    This argument is EXCLUDED and will not show up in the database.

  • arg3 => int

    This argument is included.

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.