@adyllsxn/kwavalidator 1.0.0 โ 1.0.1
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 +100 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src=".../../../../docs/assets/logotipo.svg" alt="KwaValidator Logo" width="30%" />
|
|
4
|
+
|
|
5
|
+
</br>
|
|
6
|
+
|
|
7
|
+
<h3> Cross-platform validation library for Angolan documents</h3>
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@adyllsxn/kwavalidator)
|
|
10
|
+
[](https://www.npmjs.com/package/@adyllsxn/kwavalidator)
|
|
11
|
+
[](LICENSE)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
> KwaValidator is a modern and extensible validation library focused on Angolan documents.
|
|
19
|
+
|
|
20
|
+
> Built to be lightweight, fast and framework-independent, allowing integration across multiple ecosystems and programming languages.
|
|
21
|
+
|
|
22
|
+
### Currently Supported
|
|
23
|
+
|
|
24
|
+
- ๐ฆ๐ด Bilhete de Identidade (BI)
|
|
25
|
+
|
|
26
|
+
### Planned Support
|
|
27
|
+
|
|
28
|
+
- NIF
|
|
29
|
+
- Passport
|
|
30
|
+
- Driver License
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
# ๐ FEATURES
|
|
35
|
+
|
|
36
|
+
- โก Fast validation engine
|
|
37
|
+
- ๐ Cross-platform architecture
|
|
38
|
+
- ๐งฉ Extensible document system
|
|
39
|
+
- ๐ Framework independent
|
|
40
|
+
- ๐งผ Clean and minimal API
|
|
41
|
+
- ๐ฆ Multi-ecosystem support
|
|
42
|
+
- โ No forced exceptions
|
|
43
|
+
- ๐ง Easy integration
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
# ๐ฆ ECOSYSTEM
|
|
48
|
+
|
|
49
|
+
| Platform | Package |
|
|
50
|
+
|----------|----------|
|
|
51
|
+
| .NET | `KwaValidator` |
|
|
52
|
+
| Node.js | `kwavalidator` *(planned)* |
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
# ๐ฅ INSTALLATION
|
|
57
|
+
|
|
58
|
+
## Choose your platform:
|
|
59
|
+
|
|
60
|
+
| Platform | Installation Guide |
|
|
61
|
+
|----------|-------------------|
|
|
62
|
+
| .NET | [Installation Guide](./docs/INSTALLATION-DOTNET.md) |
|
|
63
|
+
| Node.js | |
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
### Quick Examples
|
|
68
|
+
|
|
69
|
+
**.NET**
|
|
70
|
+
```csharp
|
|
71
|
+
using KwaValidator.Services;
|
|
72
|
+
|
|
73
|
+
var validator = new BiValidator();
|
|
74
|
+
var result = validator.Validate("123456789LA001");
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**Node.js (coming soon)**
|
|
78
|
+
```javascript
|
|
79
|
+
import { validateBI } from 'kwavalidator';
|
|
80
|
+
const result = validateBI('123456789LA001');
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
# ๐ PHILOSOPHY
|
|
86
|
+
|
|
87
|
+
KwaValidator does not enforce:
|
|
88
|
+
|
|
89
|
+
- Exceptions
|
|
90
|
+
- HTTP status codes
|
|
91
|
+
- Frameworks
|
|
92
|
+
- Specific return patterns
|
|
93
|
+
|
|
94
|
+
You decide how validation should behave inside your application.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
# ๐ LICENSE
|
|
99
|
+
|
|
100
|
+
> Licensed under the MIT License.
|