—package
App::lcpan::Cmd::mods;
use
5.010;
use
strict;
use
warnings;
require
App::lcpan;
our
$AUTHORITY
=
'cpan:PERLANCAR'
;
# AUTHORITY
our
$DATE
=
'2022-03-27'
;
# DATE
our
$DIST
=
'App-lcpan'
;
# DIST
our
$VERSION
=
'1.070'
;
# VERSION
our
%SPEC
;
$SPEC
{handle_cmd} =
do
{
my
$spec
= clone(
$App::lcpan::SPEC
{modules});
$spec
->{summary} =
"Alias for 'modules'"
;
$spec
;
};
*handle_cmd
= \
&App::lcpan::modules
;
1;
# ABSTRACT: Alias for 'modules'
__END__
=pod
=encoding UTF-8
=head1 NAME
App::lcpan::Cmd::mods - Alias for 'modules'
=head1 VERSION
This document describes version 1.070 of App::lcpan::Cmd::mods (from Perl distribution App-lcpan), released on 2022-03-27.
=head1 FUNCTIONS
=head2 handle_cmd
Usage:
handle_cmd(%args) -> [$status_code, $reason, $payload, \%result_meta]
Alias for 'modules'.
This function is not exported.
Arguments ('*' denotes required arguments):
=over 4
=item * B<added_or_updated_since> => I<date>
Include only records that are addedE<sol>updated since a certain date.
=item * B<added_or_updated_since_last_index_update> => I<true>
Include only records that are addedE<sol>updated since the last index update.
=item * B<added_or_updated_since_last_n_index_updates> => I<posint>
Include only records that are addedE<sol>updated since the last N index updates.
=item * B<added_since> => I<date>
Include only records that are added since a certain date.
=item * B<added_since_last_index_update> => I<true>
Include only records that are added since the last index update.
=item * B<added_since_last_n_index_updates> => I<posint>
Include only records that are added since the last N index updates.
=item * B<author> => I<str>
Filter by author.
=item * B<cpan> => I<dirname>
Location of your local CPAN mirror, e.g. E<sol>pathE<sol>toE<sol>cpan.
Defaults to C<~/cpan>.
=item * B<detail> => I<bool>
=item * B<dist> => I<perl::distname>
Filter by distribution.
=item * B<include_core> => I<bool> (default: 1)
Include core modules.
=item * B<include_noncore> => I<bool> (default: 1)
Include non-core modules.
=item * B<index_name> => I<filename> (default: "index.db")
Filename of index.
If C<index_name> is a filename without any path, e.g. C<index.db> then index will
be located in the top-level of C<cpan>. If C<index_name> contains a path, e.g.
C<./index.db> or C</home/ujang/lcpan.db> then the index will be located solely
using the C<index_name>.
=item * B<latest> => I<bool>
=item * B<namespaces> => I<array[perl::modname]>
Select modules belonging to certain namespace(s).
=item * B<or> => I<bool>
When there are more than one query, perform OR instead of AND logic.
=item * B<perl_version> => I<str> (default: "v5.34.0")
Set base Perl version for determining core modules.
=item * B<query> => I<array[str]>
Search query.
=item * B<query_type> => I<str> (default: "any")
=item * B<random> => I<true>
Random sort.
=item * B<result_limit> => I<uint>
Only return a certain number of records.
=item * B<result_start> => I<posint> (default: 1)
Only return starting from the n'th record.
=item * B<sort> => I<array[str]> (default: ["module"])
Sort the result.
=item * B<updated_since> => I<date>
Include only records that are updated since certain date.
=item * B<updated_since_last_index_update> => I<true>
Include only records that are updated since the last index update.
=item * B<updated_since_last_n_index_updates> => I<posint>
Include only records that are updated since the last N index updates.
=item * B<use_bootstrap> => I<bool> (default: 1)
Whether to use bootstrap database from App-lcpan-Bootstrap.
If you are indexing your private CPAN-like repository, you want to turn this
off.
=back
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)
By default will return an array of package names. If you set C<detail> to true,
will return array of records.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-lcpan>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-lcpan>.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required
beyond that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015 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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-lcpan>
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.
=cut