NAME
Perinci::Examples::Completion - More completion examples
VERSION
This document describes version 0.821 of Perinci::Examples::Completion (from Perl distribution Perinci-Examples), released on 2021-01-30.
FUNCTIONS
animals
Usage:
animals(%args) -> [status, msg, payload, meta]Specify an animal (optional) and a color (optional), with some examples given in argument spec or schema (for completion).
Demonstrates Rinci argument spec examples property as well as Sah schema's examples clause. This property is a source of valid values for the argument and can be used for testing, documentation, or completion.
This function is not exported.
Arguments ('*' denotes required arguments):
animal => str
color => str
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)
fruits
Usage:
fruits(%args) -> [status, msg, payload, meta]Demonstrates completion of array elements, with description for each word.
This function is not exported.
Arguments ('*' denotes required arguments):
category => str
This argument contains valid values and their summaries in the schema.
fruits => array[str]
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) 2021, 2020, 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.