npm package: @handsomewolf/num-utils
Description: A collection of number utilities.
Author: HandsomeWolf
Latest version: 1.0.4
Deprecated: This package has been renamed to 'pixiu-number-toolkit'. Please install the new package for future updates.

[README](README.md) | [中文文档](README_zh-CN.md)

# num-utils Documentation

num-utils is a collection of number utilities written in TypeScript. It provides a set of functions for number conversion, finance calculations, formatting, and math operations. It also includes utilities for Vue's Element Plus library.

[Documentation](https://handsomewolf.github.io/num-utils/) - Official guide for num-utils with examples and usage scenarios.

[Changelog](https://handsomewolf.github.io/num-utils/changelog.html) - View the detailed version history of num-utils here.

## Installation

To install `num-utils`, use the following command:

```command
npm install @handsomewolf/num-utils
```

## Utilities

### Basic Utilities

| Function Name                                                                                          | Description                                                         |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- |
| [Digit Chinese Uppercase](https://handsomewolf.github.io/num-utils/guide/digit-chinese-uppercase.html) | Convert numeric amount to Chinese uppercase                         |
| [Number To Words](https://handsomewolf.github.io/num-utils/guide/number-to-words.html)                 | Convert numeric to word representation in either English or Chinese |
| [Math](https://handsomewolf.github.io/num-utils/guide/math.html)                                       | Performing various mathematical operations                          |
| [Thousand Separator](https://handsomewolf.github.io/num-utils/guide/thousand-separator.html)           | Add or remove thousand separator                                    |
| [Percentage](https://handsomewolf.github.io/num-utils/guide/percentage.html)                           | Convert number to percentage format                                 |
| [Compute expression](https://handsomewolf.github.io/num-utils/guide/compute-expression.html)           | Mathematical formula                                                |
| [Unit Conversion](https://handsomewolf.github.io/num-utils/guide/unit-conversion.html)                 | Unit conversion                                                     |
| [Validation](https://handsomewolf.github.io/num-utils/guide/validation.html)                           | Numeric related validation                                          |
| [Utils](https://handsomewolf.github.io/num-utils/guide/utils.html)                                     | Common tools                                                        |

### Element Plus Utilities

| Function Name                                                                                           | Description                                                      |
| ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| [Thousand Separator](https://handsomewolf.github.io/num-utils/guide/element-plus-formatter.html)        | Use thousand separator in Element Plus library's input component |
| [Form Validation](https://handsomewolf.github.io/num-utils/guide/element-plus-form-validation.html)     | Use form validation in Element Plus library's Form component     |
| [Table Summary Row](https://handsomewolf.github.io/num-utils/guide/element-plus-table-summary-row.html) | Use summary row in Element Plus library's Table component        |

## Contributing

Contributions are welcome. Please submit a pull request or create an issue to contribute to the project.