@utils-fns/utils/README.md

 [](LICENSE) [](https://github.com/ccqueiroz/utils-fn)

# @utils-fns/utils

![npm](https://img.shields.io/npm/v/@utils-fns/utils)
[![License](https://img.shields.io/github/license/ccqueiroz/utils-fns)](LICENSE)
[![Repository](https://img.shields.io/badge/repository-GitHub-blue.svg)](https://github.com/ccqueiroz/utils-fn)

## README versions
[Portuguese 🇧🇷](https://github.com/ccqueiroz/utils-fns/blob/main/packages/utils/README-pt.md)  |  [English 🇺🇸](https://github.com/ccqueiroz/utils-fns/blob/main/packages/utils/README.md)

<p align="justify">
  The @utils-fns/utils library is being developed to be part of a larger library, @utils-fns, which is being developed with the aim of providing unified tools that facilitate programmers' daily tasks. Our motivation is to simplify common tasks, such as validators, value masking, classification, search and conversion methods, offering a comprehensive and efficient solution and making it possible to use this set of libraries in web - mobile - service environments.
</p>

## ✨ Features
### Utils: The ```@utils-fns/utils``` library provides a wide range of methods to help with day-to-day programming:
**Module under construction**
- [x] **Data List Cities (BR)**
- [x] **Data List States (BR)**
- [x] **Data List Countries**
- [x] **Lunh Algorithm**
- [x] **Lunh Algorithm Mod10**
- [x] **Lunh Algorithm Mod11**
- [x] **Payment Card Data List**
- [x] **Normalize Words**
- [ ] **Sorting Algorithms**
  - [ ] **Bubble Sort**
  - [ ] **Merge Sort**
  - [ ] **Quick Sort**
  - [ ] **Heap Sort**
  - [ ] **Alphanumeric Sort**
  - [ ] **Heap**
  - [ ] **Selection**
  - [ ] **Bubble**
  - [ ] **Merge**
- [ ] **Searching Algorithms**
  - [ ] **Binary Search**
  - [ ] **Breadth-First**
  - [ ] **Depth-First**
  - [ ] **Exponential Search**
  - [ ] **Heap Sort**
- [ ] **Generate File Hash**
- [ ] **converter base64**
- [ ] **unConverter base64**
- [ ] **Params serializer**
- [ ] **PrintPDF**
- [ ] **Blob dowload**
- [ ] **Generate Password**
- [ ] **Convert Hex To RGB**
- [ ] **Add Opacity In Color Rgb**

## 🖥 Environment Support
- Applications with javascript ES6 or higher
  - Modern browsers
  - Server-side
  - Electron
  - Mobile
## 📦 Install
If you want to install the complete module, follow the documentation of the [@utils-fns/utils-fns](https://github.com/ccqueiroz/utils-fns/blob/main/packages/utils-fns/README.md).

To install the @utils-fns/utils library: use your preferred package manager

```javascript
  yarn add @utils-fns/utils

  or

  npm install @utils-fns/utils
```

## 🔨 How to use
To access the features, just follow the example:

```javascript
  //ES6
  import { utils } from "@utils-fns/utils";
```
```javascript
  //CommomJS
  const { utils } = require("@utils-fns/utils");
```

**Module under construction**

### Author

<div style="margin-top: 15px; margin-bottom: 5px;">
    <img style="border-radius: 50%;" src="https://github.com/ccqueiroz.png" width="100px;" alt=""/>
    <br />
    <sub style="margin-left: 15px">
        <b>Caio Queiroz</b>
    </sub>
</div>

[![Linkedin Badge](https://img.shields.io/badge/-Caio%20Queiroz-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/caio-queiroz-83846399/)](https://www.linkedin.com/in/caio-queiroz-83846399/)
[![Gmail Badge](https://img.shields.io/badge/-caio.cezar.dequeiroz@gmail.com-c14438?style=flat-square&logo=Gmail&logoColor=white&link=mailto:caio.cezar.dequeiroz@gmail.com)](mailto:caio.cezar.dequeiroz@gmail.com)


## License

This API is licensed [MIT](./LICENSE).