@types/numeral

What is @types/numeral?

@types/numeral provides TypeScript type definitions for the numeral.js library, which is used for formatting and manipulating numbers.

What are @types/numeral's main functionalities?

Number Formatting

This feature allows you to format numbers in various ways, such as adding commas as thousand separators.

const numeral = require('numeral');
const formattedNumber = numeral(1000).format('0,0');
console.log(formattedNumber); // Output: '1,000'

Currency Formatting

This feature allows you to format numbers as currency, including the appropriate currency symbol and decimal places.

const numeral = require('numeral');
const formattedCurrency = numeral(1000).format('$0,0.00');
console.log(formattedCurrency); // Output: '$1,000.00'

Percentage Formatting

This feature allows you to format numbers as percentages, including the percentage symbol and decimal places.

const numeral = require('numeral');
const formattedPercentage = numeral(0.25).format('0.00%');
console.log(formattedPercentage); // Output: '25.00%'

Unformatting

This feature allows you to convert formatted strings back into numbers.

const numeral = require('numeral');
const number = numeral().unformat('$1,000.00');
console.log(number); // Output: 1000

Other packages similar to @types/numeral

accounting

The accounting.js library provides similar functionality for number, money, and currency formatting. It is simpler and more lightweight compared to numeral.js, but it may lack some of the advanced features.

currency.js

The currency.js library focuses specifically on currency formatting and manipulation. It offers a more modern API and better performance for currency-related tasks compared to numeral.js.

dinero.js

Dinero.js is a library for working with monetary values in JavaScript. It provides a more comprehensive and robust API for handling money, including arithmetic operations, formatting, and internationalization, making it more suitable for complex financial applications.

README

Installation

npm install --save @types/numeral

Summary

This package contains type definitions for Numeral.js (https://github.com/adamwdraper/Numeral-js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/numeral.

Additional Details

• Last updated: Fri, 22 Jan 2021 00:05:16 GMT
• Dependencies: none
• Global values: numeral

Credits

These definitions were written by Vincent Bortone, Kenneth Luján, and Carlos Quiroga.