/ 
Complete-Random-0.002
River stage one • 2 direct dependents • 2 total dependents
/ Complete::Random

NAME

Complete::Random - Complete from a list of random string

VERSION

This document describes version 0.002 of Complete::Random (from Perl distribution Complete-Random), released on 2022-09-08.

DESCRIPTION

This module is mainly for testing.

FUNCTIONS

complete_random_string

Usage:

complete_random_string(%args) -> [$status_code, $reason, $payload, \%result_meta]

Complete from a list of random string.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • len => int (default: 10)

    Length of random string to produce.

  • num => any

    Number of random string answers to generate.

    Will observe COMPLETE_RANDOM_STRING_NUM environment variable for the default, or fall back to 50.

  • summaries => bool

  • summary_len => int (default: 50)

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

ENVIRONMENT

COMPLETE_RANDOM_STRING_NUM

Uint. Number of completion answers to produce.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Complete-Random.

SOURCE

Source repository is at https://github.com/perlancar/perl-Complete-Random.

SEE ALSO

Complete

Other Complete::* modules.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by perlancar <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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Complete-Random

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.