NAME

Data::Unixish::num - Format number

VERSION

This document describes version 1.573 of Data::Unixish::num (from Perl distribution Data-Unixish), released on 2023-09-23.

SYNOPSIS

In Perl:

 use Data::Unixish qw(lduxl);
 my @res = lduxl([num => {style=>"fixed"}], 0, 10, -2, 34.5, [2], {}, "", undef);
 # => ("0.00", "10.00", "-2.00", "34.50", [2], {}, "", undef)

In command line:

 % echo -e "1\n-2\n" | LANG=id_ID dux num -s fixed --format=text-simple
 1,00
 -2,00

FUNCTIONS

num

Usage:

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

Format number.

Observe locale environment variable settings.

Undef and non-numbers are ignored.

This function is not exported.

Arguments ('*' denotes required arguments):

• decimal_digits => int

  Number of digits to the right of decimal point.

• in => array

  Input stream (e.g. array or filehandle).

• out => any

  Output stream (e.g. array or filehandle).

• prefix => str

  Add some string at the beginning (e.g. for currency).

• style => str (default: "general")

  Available styles:

  • fixed (Fixed number of decimal digits, e.g. 1.00, default decimal digits=2)

  • general (General formatting, e.g. 1, 2.345)

  • kibi (Use Ki/Mi/GiB/etc suffix with base-10 [1000], e.g. 1.2Mi)

  • kilo (Use K/M/G/etc suffix with base-2, e.g. 1.2M)

  • percent (Percentage, e.g. 10.00%)

  • scientific (Scientific notation, e.g. 1.23e+21)

• suffix => str

  Add some string at the end (e.g. for unit).

• thousands_sep => str

  Use a custom thousand separator character.

  Default is from locale (e.g. dot "." for en_US, etc).

  Use empty string "" if you want to disable printing thousands separator.

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/Data-Unixish.

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Unixish.

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, 2019, 2017, 2016, 2015, 2014, 2013, 2012 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=Data-Unixish

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.

cpanm Data::Unixish

perl -MCPAN -e shell
install Data::Unixish