/ 
App-ListCurrencies-0.004
River stage one • 1 direct dependent • 1 total dependent
/ App::ListCurrencies

NAME

App::ListCurrencies - List currencies

VERSION

This document describes version 0.004 of App::ListCurrencies (from Perl distribution App-ListCurrencies), released on 2019-09-28.

SYNOPSIS

# Use via list-currencies CLI script

FUNCTIONS

list_currencies

Usage:

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

List currencies.

Examples:

  • Example #1:

    list_currencies(query => "rup"); # -> ["IDR", "INR", "LKR", "MUR", "NPR", "PKR", "SCR"]

  • Example #2:

    list_currencies(query => "rup", detail => 1);

    Result:

    [
  { alpha => "IDR", en_name => "Rupiah" },
  { alpha => "INR", en_name => "Indian Rupee" },
  { alpha => "LKR", en_name => "Sri Lanka Rupee" },
  { alpha => "MUR", en_name => "Mauritius Rupee" },
  { alpha => "NPR", en_name => "Nepalese Rupee" },
  { alpha => "PKR", en_name => "Pakistan Rupee" },
  { alpha => "SCR", en_name => "Seychelles Rupee" },
]

Source data is generated from Locale::Codes::Currency_Codes. so make sure you have a relatively recent version of the module.

This function is not exported.

Arguments ('*' denotes required arguments):

  • alpha => str

    Only return records where the 'alpha' field equals specified value.

  • alpha.contains => str

    Only return records where the 'alpha' field contains specified text.

  • alpha.in => array[str]

    Only return records where the 'alpha' field is in the specified values.

  • alpha.is => str

    Only return records where the 'alpha' field equals specified value.

  • alpha.isnt => str

    Only return records where the 'alpha' field does not equal specified value.

  • alpha.max => str

    Only return records where the 'alpha' field is less than or equal to specified value.

  • alpha.min => str

    Only return records where the 'alpha' field is greater than or equal to specified value.

  • alpha.not_contains => str

    Only return records where the 'alpha' field does not contain specified text.

  • alpha.not_in => array[str]

    Only return records where the 'alpha' field is not in the specified values.

  • alpha.xmax => str

    Only return records where the 'alpha' field is less than specified value.

  • alpha.xmin => str

    Only return records where the 'alpha' 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.

  • en_name => str

    Only return records where the 'en_name' field equals specified value.

  • en_name.contains => str

    Only return records where the 'en_name' field contains specified text.

  • en_name.in => array[str]

    Only return records where the 'en_name' field is in the specified values.

  • en_name.is => str

    Only return records where the 'en_name' field equals specified value.

  • en_name.isnt => str

    Only return records where the 'en_name' field does not equal specified value.

  • en_name.max => str

    Only return records where the 'en_name' field is less than or equal to specified value.

  • en_name.min => str

    Only return records where the 'en_name' field is greater than or equal to specified value.

  • en_name.not_contains => str

    Only return records where the 'en_name' field does not contain specified text.

  • en_name.not_in => array[str]

    Only return records where the 'en_name' field is not in the specified values.

  • en_name.xmax => str

    Only return records where the 'en_name' field is less than specified value.

  • en_name.xmin => str

    Only return records where the 'en_name' field is greater than specified value.

  • fields => array[str]

    Select fields to return.

  • query => str

    Search.

  • 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) 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/App-ListCurrencies.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-ListCurrencies.

BUGS

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

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.

SEE ALSO

Locale::Codes

list-countries from App::ListCountries

list-languages from App::ListLanguages

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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