@arkyn/shared 2.0.1-beta.15 → 2.0.1-beta.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@ The `@arkyn/shared` package provides reusable utilities such as formatting funct
|
|
|
2
2
|
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
7
|
Install the package using npm:
|
|
8
8
|
|
|
@@ -12,9 +12,9 @@ npm install @arkyn/shared
|
|
|
12
12
|
|
|
13
13
|
---
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Features
|
|
16
16
|
|
|
17
|
-
###
|
|
17
|
+
### Formatting
|
|
18
18
|
|
|
19
19
|
- **`formatDate(date: Date): string`**
|
|
20
20
|
Formats a date into a readable string.
|
|
@@ -51,7 +51,7 @@ npm install @arkyn/shared
|
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
|
-
###
|
|
54
|
+
### Generators
|
|
55
55
|
|
|
56
56
|
- **`generateColorByString(value: string): string`**
|
|
57
57
|
Generates a hexadecimal color based on a string.
|
|
@@ -64,7 +64,7 @@ npm install @arkyn/shared
|
|
|
64
64
|
|
|
65
65
|
---
|
|
66
66
|
|
|
67
|
-
###
|
|
67
|
+
### Services
|
|
68
68
|
|
|
69
69
|
- **`calculateCardInstallment(total: number, installments: number): number[]`**
|
|
70
70
|
Calculates the installment values for a given total.
|
|
@@ -80,7 +80,7 @@ npm install @arkyn/shared
|
|
|
80
80
|
|
|
81
81
|
---
|
|
82
82
|
|
|
83
|
-
###
|
|
83
|
+
### Validations
|
|
84
84
|
|
|
85
85
|
- **`validateCep(value: string): boolean`**
|
|
86
86
|
Validates whether a string is a valid CEP.
|
|
@@ -102,12 +102,12 @@ npm install @arkyn/shared
|
|
|
102
102
|
|
|
103
103
|
---
|
|
104
104
|
|
|
105
|
-
##
|
|
105
|
+
## Contribution
|
|
106
106
|
|
|
107
107
|
Contributions are welcome! Feel free to open issues or submit pull requests to improve the project.
|
|
108
108
|
|
|
109
109
|
---
|
|
110
110
|
|
|
111
|
-
##
|
|
111
|
+
## License
|
|
112
112
|
|
|
113
113
|
This project is licensed under the MIT License. See the `LICENSE` file for more details.
|