NAME
App::LocaleCodesUtils::ListCountries - Backend module for list-countries
VERSION
This document describes version 0.004 of App::LocaleCodesUtils::ListCountries (from Perl distribution App-LocaleCodesUtils), released on 2023-08-06.
FUNCTIONS
list_countries
Usage:
list_countries(%args) -> [$status_code, $reason, $payload, \%result_meta]
List countries.
REPLACE ME
This function is not exported.
Arguments ('*' denotes required arguments):
alpha2 => str
Only return records where the 'alpha2' field equals specified value.
alpha2.contains => str
Only return records where the 'alpha2' field contains specified text.
alpha2.in => array[str]
Only return records where the 'alpha2' field is in the specified values.
alpha2.is => str
Only return records where the 'alpha2' field equals specified value.
alpha2.isnt => str
Only return records where the 'alpha2' field does not equal specified value.
alpha2.max => str
Only return records where the 'alpha2' field is less than or equal to specified value.
alpha2.min => str
Only return records where the 'alpha2' field is greater than or equal to specified value.
alpha2.not_contains => str
Only return records where the 'alpha2' field does not contain specified text.
alpha2.not_in => array[str]
Only return records where the 'alpha2' field is not in the specified values.
alpha2.xmax => str
Only return records where the 'alpha2' field is less than specified value.
alpha2.xmin => str
Only return records where the 'alpha2' field is greater than specified value.
alpha3 => str
Only return records where the 'alpha3' field equals specified value.
alpha3.contains => str
Only return records where the 'alpha3' field contains specified text.
alpha3.in => array[str]
Only return records where the 'alpha3' field is in the specified values.
alpha3.is => str
Only return records where the 'alpha3' field equals specified value.
alpha3.isnt => str
Only return records where the 'alpha3' field does not equal specified value.
alpha3.max => str
Only return records where the 'alpha3' field is less than or equal to specified value.
alpha3.min => str
Only return records where the 'alpha3' field is greater than or equal to specified value.
alpha3.not_contains => str
Only return records where the 'alpha3' field does not contain specified text.
alpha3.not_in => array[str]
Only return records where the 'alpha3' field is not in the specified values.
alpha3.xmax => str
Only return records where the 'alpha3' field is less than specified value.
alpha3.xmin => str
Only return records where the 'alpha3' field is greater than specified value.
detail => bool (default: 0)
Return array of full records instead of just ID fields.
By default, only the key (ID) field is returned per result entry.
exclude_fields => array[str]
Select fields to return.
fields => array[str]
Select fields to return.
name => str
Only return records where the 'name' field equals specified value.
name.contains => str
Only return records where the 'name' field contains specified text.
name.in => array[str]
Only return records where the 'name' field is in the specified values.
name.is => str
Only return records where the 'name' field equals specified value.
name.isnt => str
Only return records where the 'name' field does not equal specified value.
name.max => str
Only return records where the 'name' field is less than or equal to specified value.
name.min => str
Only return records where the 'name' field is greater than or equal to specified value.
name.not_contains => str
Only return records where the 'name' field does not contain specified text.
name.not_in => array[str]
Only return records where the 'name' field is not in the specified values.
name.xmax => str
Only return records where the 'name' field is less than specified value.
name.xmin => str
Only return records where the 'name' field is greater than specified value.
queries => array[str]
Search.
This will search all searchable fields with one or more specified queries. Each query can be in the form of
-FOO
(dash prefix notation) to require that the fields do not contain specified string, or/FOO/
to use regular expression. All queries must match if thequery_boolean
option is set toand
; only one query should match if thequery_boolean
option is set toor
.query_boolean => str (default: "and")
Whether records must match all search queries ('and') or just one ('or').
If set to
and
, all queries must match; if set toor
, only one query should match. See thequeries
option for more details on searching.random => bool (default: 0)
Return records in random order.
result_limit => int
Only return a certain number of records.
result_start => int (default: 1)
Only return starting from the n'th record.
sort => array[str]
Order records according to certain field(s).
A list of field names separated by comma. Each field can be prefixed with '-' to specify descending order instead of the default ascending.
with_field_names => bool
Return field names in each record (as hash/associative array).
When enabled, function will return each record as hash/associative array (field name => value pairs). Otherwise, function will return each record as list/array (field value, field value, ...).
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)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-LocaleCodesUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-LocaleCodesUtils.
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) 2023, 2020, 2018 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=App-LocaleCodesUtils
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.