ngx-number-to-words
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

ngx-number-to-words

ngx-number-to-words is an Angular library that provides a simple and effective pipe to convert numbers into their respective word representations. This is particularly useful for applications that need to display numbers in words, such as invoices, reports, or financial applications.


Features

  • Converts numbers into human-readable words
  • Easily integrated into Angular 17+ applications
  • Simple API with no dependencies

Installation

Install via npm:

npm install ngx-number-to-words

Usage

1. Import the Library Module

In your Angular project, import the NgxNumberToWordsPipe from ngx-number-to-words in your application module (or any other module where you want to use the pipe):

import { NgxNumberToWordsPipe } from 'ngx-number-to-words';

@NgModule({
    declarations: [AppComponent],
    imports: [NgxNumberToWordsPipe], // Add the module here
    bootstrap: [AppComponent]
})
export class AppModule { }

By importing the module, you'll have access to the numberToWords pipe throughout your application.


2. Using the Pipe in Your Templates

Once the module is imported, you can use the numberToWords pipe directly in your templates to convert any number to its word representation:

<p>{{ 123 | numberToWords }}</p>

This will display:

One hundred twenty three

You can use this pipe with any numeric value, and it will return the number written out in words.

Example

<!-- Display numbers in words -->
<p>{{ 1 | numberToWords }}</p>   <!-- Output: One -->
<p>{{ 45 | numberToWords }}</p>  <!-- Output: Forty five -->
<p>{{ 99 | numberToWords }}</p>  <!-- Output: Ninety nine -->
<p>{{ 200 | numberToWords }}</p> <!-- Output: Two hundred -->
<p>{{ 999 | numberToWords }}</p> <!-- Output: Nine hundred and ninety nine -->

3. Handling Invalid Inputs

If the pipe receives an invalid input (e.g., NaN, a string, or a non-numeric value), it will return the string:

Invalid number

For example:

<p>{{ 'abc' | numberToWords }}</p>  <!-- Output: Invalid number -->

The pipe gracefully handles incorrect or non-numeric values and ensures the application doesn't break, returning a simple "Invalid number" message instead.


License

This project is licensed under the MIT License. (©) Vipin.


Happy coding! 🚀

Package Sidebar

Install

npm i ngx-number-to-words

Weekly Downloads

5

Version

1.0.3

License

MIT

Unpacked Size

24.5 kB

Total Files

12

Last publish

Collaborators

  • vipinkc4