npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

reduce-precision

v1.0.4

Published

[![Known Vulnerabilities](https://snyk.io/test/github/ArzDigitalLabs/reduce-precision/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ArzDigitalLabs/reduce-precision?targetFile=package.json) [![Build Status](https://travis-ci.org/ArzDigita

Downloads

138

Readme

reduce-precision

Known Vulnerabilities Build Status codecov.io Code Coverage Code Climate NPM Version

reduce-precision is a versatile package for formatting and reducing the precision of numbers, currencies, and percentages. It supports various templates, precision levels, languages, and output formats, making it easy to generate formatted strings for different use cases.

Features

  • Format numbers with customizable precision levels: high, medium, low, or auto
  • Support for multiple templates: number, USD, IRT (Iranian Toman), IRR (Iranian Rial), and percent
  • Multilingual support: English and Persian (Farsi)
  • Output formats: plain text, HTML, and Markdown
  • Customizable prefix and postfix markers for HTML and Markdown output
  • Intelligent handling of very small and very large numbers
  • Automatic thousand separators and decimal points based on the selected language
  • TypeScript type definitions included

Installation

Node.js / TypeScript

You can install reduce-precision using npm:

npm install reduce-precision

NPM Download Stats

PHP

You can install the PHP version of reduce-precision via Composer:

composer require arzdigitallabs/reduce-precision

Usage

Node.js / TypeScript

import { NumberFormatter } from 'reduce-precision';

const formatter = new NumberFormatter();

formatter.setLanguage('en', { prefixMarker: 'strong', prefix: 'USD ' });

console.log(formatter.toHtmlString(123456789));
console.log(formatter.toJson(123456789));
console.log(formatter.toString(123456789));

PHP

require 'vendor/autoload.php';

use NumberFormatter\NumberFormatter;

$formatter = new NumberFormatter();
echo $formatter->toString(12345.678); // Default format

Options

The format function accepts an optional options object with the following properties:

| Option | Type | Default | Description | | --------------- | ---------------------------------------------------------- | ---------- | ----------------------------------------------------- | | precision | 'auto' | 'high' | 'medium' | 'low' | 'high' | Precision level for formatting | | template | 'number' | 'usd' | 'irt' | 'irr' | 'percent' | 'number' | Template for formatting | | language | 'en' | 'fa' | 'en' | Language for formatting (English or Persian) | | outputFormat | 'plain' | 'html' | 'markdown' | 'plain' | Output format | | prefixMarker | string | 'i' | Prefix marker for HTML and Markdown output | | postfixMarker | string | 'i' | Postfix marker for HTML and Markdown output | | prefix | string | '' | Prefix string to be added before the formatted number | | postfix | string | '' | Postfix string to be added after the formatted number |

Examples

TypeScript/Node.js

import { NumberFormatter } from 'reduce-precision';

// Create a formatter instance with default options
const formatter = new NumberFormatter();

// Basic usage
formatter.setLanguage('en');

// Basic number formatting
formatter.toJson(1234.5678); // Output: { value: '1,234.6', ... }

// Formatting with medium precision
formatter.setTemplate('number', 'medium').toJson(1234.5678); // Output: { value: '1.23K', ... }

// Formatting as USD
formatter.setTemplate('usd', 'high').toJson(1234.5678); // Output: { value: '$1,234.6', ... }

// Formatting as Iranian Rial with Persian numerals
formatter.setLanguage('fa');
formatter.setTemplate('irr', 'medium').toJson(1234.5678); // Output: { value: '۱٫۲۳ هزار ریال', ... }

// Formatting as a percentage with low precision
formatter.setTemplate('percent', 'low').toJson(0.1234); // Output: { value: '0.12%', ... }

// Formatting with HTML output and custom markers
formatter
  .setLanguage('en', { prefixMarker: 'strong', prefix: 'USD ' })
  .toHtmlString(1234.5678);
// Output: <strong>USD </strong>1,234.6

// Formatting with string input for small or big numbers
formatter.setTemplate('usd', 'medium').toJson('0.00000000000000000000005678521');
// Output: { value: '$0.0₂₂5678', ... }

PHP

require 'vendor/autoload.php';

use NumberFormatter\NumberFormatter;

$formatter = new NumberFormatter();
echo $formatter->toString(12345.678); // Default format

$formatter->setLanguage('fa');
echo $formatter->toString(12345.678); // Output in Persian

$formatter->setTemplate('usd', 'high');
echo $formatter->toString(12345.678); // Output in USD format with high precision

echo $formatter->toHtmlString(12345.678);  // HTML formatted output
echo $formatter->toMdString(12345.678);    // Markdown formatted output

API

FormattedObject Interface (TypeScript/Node.js)

The FormattedObject interface represents the structure of the formatted number object returned by the format method.

interface FormattedObject {
  value: string; // The formatted value as a string
  prefix: string; // The prefix string
  postfix: string; // The postfix string
  sign: string; // The sign of the number (either an empty string or '-')
  wholeNumber: string; // The whole number part of the value
}

NumberFormatter Class (PHP)

constructor

Creates a new instance of the NumberFormatter class with optional configuration options.

setLanguage

Sets the language and optional language configuration for the formatter.

setTemplate

Sets the template and precision for the formatter.

toString

Formats the input number as a string.

toPlainString

Formats the input number as a plain text string.

toHtmlString

Formats the input number as an HTML string.

toMdString

Formats the input number as a Markdown string.

Testing

Node.js / TypeScript

You can run tests using Jest or any other preferred testing framework for TypeScript.

PHP

You can run tests using PHPUnit:

./vendor/bin/phpunit tests

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository. If you'd like to contribute code, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License.