@arkyn/shared 2.0.1-beta.14 → 2.0.1-beta.16

package/README.md

@@ -1,100 +1,113 @@
-# @arkyn/shared
+The `@arkyn/shared` package provides reusable utilities such as formatting functions, generators, services, and validations. It is designed to be used across different parts of a project, offering common and practical solutions to streamline development.
 
-The `@arkyn/shared` package provides reusable items such as formatting functions, generators, services, and
-validations. It is designed to be used in different parts of a project, providing common and practical solutions.
+---
 
 ## Installation
 
+Install the package using npm:
+
 ```bash
 npm install @arkyn/shared
 ```
 
-### Features
+---
+
+## Features
 
-#### Formatting
+### Formatting
 
-`formatDate(date: Date): string`
-Formats a date in a readable format.
+- **`formatDate(date: Date): string`**  
+  Formats a date into a readable string.
 
-`formatJsonObject(obj: object): string`
-Converts a JSON object into a formatted string.
+- **`formatJsonObject(obj: object): string`**  
+  Converts a JSON object into a formatted string.
 
-`formatJsonString(json: string): object`
-Converts a JSON string into an object.
+- **`formatJsonString(json: string): object`**  
+  Converts a JSON string into an object.
 
-`formatToCep(value: string): string`
-Formats a string into the CEP format (XXXXX-XXX).
+- **`formatToCep(value: string): string`**  
+  Formats a string into the CEP format (`XXXXX-XXX`).
 
-`formatToCnpj(value: string): string`
-Formats a string into the CNPJ format (XX.XXX.XXX/XXXX-XX).
+- **`formatToCnpj(value: string): string`**  
+  Formats a string into the CNPJ format (`XX.XXX.XXX/XXXX-XX`).
 
-`formatToCpf(value: string): string`
-Formats a string into the CPF format (XXX.XXX.XXX-XX).
+- **`formatToCpf(value: string): string`**  
+  Formats a string into the CPF format (`XXX.XXX.XXX-XX`).
 
-`formatToCpfCnpj(value: string): string`
-Formats a string into the CPF or CNPJ format, depending on the size.
+- **`formatToCpfCnpj(value: string): string`**  
+  Formats a string into either CPF or CNPJ format, depending on its length.
 
-`formatToCurrency(value: number): string`
-Converts a number to currency format.
+- **`formatToCurrency(value: number): string`**  
+  Converts a number into a currency format.
 
-`formatToEllipsis(value: string, maxLength: number): string`
-Truncates a string and adds an ellipsis if it exceeds the maximum length.
+- **`formatToEllipsis(value: string, maxLength: number): string`**  
+  Truncates a string and appends an ellipsis if it exceeds the maximum length.
 
-`formatToHiddenDigits(value: string): string`
-Hides part of a string, replacing it with asterisks.
+- **`formatToHiddenDigits(value: string): string`**  
+  Masks part of a string by replacing it with asterisks.
 
-`formatToPhone(value: string): string`
-Formats a string to phone number format.
+- **`formatToPhone(value: string): string`**  
+  Formats a string into a phone number format.
+
+---
 
 ### Generators
 
-`generateColorByString(value: string): string`
-Generates a hexadecimal color from a string.
+- **`generateColorByString(value: string): string`**  
+  Generates a hexadecimal color based on a string.
+
+- **`generateId(): string`**  
+  Generates a unique identifier.
 
-`generateId(): string`
-Generates a unique identifier.
+- **`generateSlug(value: string): string`**  
+  Converts a string into a URL-friendly slug.
 
-`generateSlug(value: string): string`
-Generates a URL-friendly slug from a string.
+---
 
 ### Services
 
-`calculateCardInstallment(total: number, installments: number): number[]`
-Calculates the installment value of a total.
+- **`calculateCardInstallment(total: number, installments: number): number[]`**  
+  Calculates the installment values for a given total.
 
-`maskSensitiveData(data: string): string`
-Hides sensitive data in a string.
+- **`maskSensitiveData(data: string): string`**  
+  Masks sensitive data in a string.
 
-`removeNonNumeric(value: string): string`
-Removes non-numeric characters from a string.
+- **`removeNonNumeric(value: string): string`**  
+  Removes all non-numeric characters from a string.
 
-`truncateLargeFields(obj: object, maxLength: number): object`
-Truncates large fields in an object.
+- **`truncateLargeFields(obj: object, maxLength: number): object`**  
+  Truncates large fields in an object to a specified maximum length.
+
+---
 
 ### Validations
 
-`validateCep(value: string): boolean`
-Validates whether a string is a valid CEP.
+- **`validateCep(value: string): boolean`**  
+  Validates whether a string is a valid CEP.
+
+- **`validateCnpj(value: string): boolean`**  
+  Validates whether a string is a valid CNPJ.
 
-`validateCnpj(value: string): boolean`
-Validates whether a string is a valid CNPJ.
+- **`validateCpf(value: string): boolean`**  
+  Validates whether a string is a valid CPF.
 
-`validateCpf(value: string): boolean`
-Validates whether a string is a valid CPF.
+- **`validateDate(value: string): boolean`**  
+  Validates whether a string is a valid date.
 
-`validateDate(value: string): boolean`
-Validates whether a string is a valid date.
+- **`validatePhone(value: string): boolean`**  
+  Validates whether a string is a valid phone number.
 
-`validatePhone(value: string): boolean`
-Validates whether a string is a valid phone number.
+- **`validateRg(value: string): boolean`**  
+  Validates whether a string is a valid ID (RG).
 
-`validateRg(value: string): boolean`
-Validates whether a string is a valid ID.
+---
 
 ## Contribution
 
-Contributions are welcome! Feel free to open issues or submit pull requests.
+Contributions are welcome! Feel free to open issues or submit pull requests to improve the project.
+
+---
 
 ## License
 
-MIT
+This project is licensed under the MIT License. See the `LICENSE` file for more details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyn/shared",
-  "version": "2.0.1-beta.14",
+  "version": "2.0.1-beta.16",
   "main": "./dist/bundle.js",
   "module": "./src/index.ts",
   "type": "module",