Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dev-ks-155/validator360
Validator360 is a robust validation package that ensures data integrity by checking required fields, such as strings, objects, arrays, numbers, and more, to ensure they are not null, undefined, or empty. It also validates specific formats for emails, passwords, phone numbers and url .
https://github.com/dev-ks-155/validator360
dynamic-validator empty-check jest-tests nodejs npm-package null-check validation-tool
Last synced: about 1 month ago
JSON representation
Validator360 is a robust validation package that ensures data integrity by checking required fields, such as strings, objects, arrays, numbers, and more, to ensure they are not null, undefined, or empty. It also validates specific formats for emails, passwords, phone numbers and url .
- Host: GitHub
- URL: https://github.com/dev-ks-155/validator360
- Owner: dev-KS-155
- License: mit
- Created: 2024-09-07T23:22:33.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T19:50:56.000Z (2 months ago)
- Last Synced: 2024-10-12T08:04:11.687Z (about 1 month ago)
- Topics: dynamic-validator, empty-check, jest-tests, nodejs, npm-package, null-check, validation-tool
- Language: JavaScript
- Homepage:
- Size: 241 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Validotor360
Validotor360 is a robust validation package that ensures data integrity by checking required fields, such as strings, objects, arrays, numbers, and more, to ensure they are not null, undefined, or empty. It also validates specific formats for emails, passwords, and phone numbers.
## Installation
To install the package, run:
```bash
npm install validotor360
```
## Validotor360 Service
| NameOfService | All Service |
|---------------------|------------------------------------------------------------------------------------------------------|
| `customValidation` | `addCustomValidator`, `validateWithCustom` |
| `emptyValidation` | `singleEmptyValidation`, `validateAllFields` |
| `filetypeValidation` | `validateSingleFileSize`, `validateFileSize`, `validateSingleMimeType`, `validateMimeTypes` |
| `regexFormatValidation` | `validateEmail`, `validatePhone`, `validateURL`, `validatePassword`, `validateDate`, `validateCreditCard` |
## Usage
You can import any of these functions based on your needs:
```
const {
customValidation,
emptyValidation,
filetypeValidation,
regexFormatValidation,
} = require('validator360');
// Example: Using regexValidation
const { validateEmail } = regexValidation;
// Example: Using fileValidation
const {validateSingleFileSize , validateSingleMimeType} = fileValidation
```
Alternatively, you can use direct imports:
```
const { validateEmail } = require('validator360/regexFormatValidation');
const { singleEmptyValidation } = require('validator360/emptyValidation');
```
## Function Descriptions
| Function Name | Purpose | Input | Example | Output |
|--------------------------|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
| `singleEmptyValidation` | Validates if a single field is empty, null, or undefined. | - `value` (the value to check)
- `fieldName` (the name of the field)
- `customMessage` (Optional) | `const response = singleEmptyValidation(value, "fieldName", "customMessage");` | - Returns: `"{fieldName} is required"` if empty.
- Returns: `null` if valid. |
| `validateAllFields` | Validates all fields in an object, checking if any are empty, null, or undefined. | - `data` (an object with key-value pairs)
- `customMessage` (Optional) | `const data = { stringFieldName: "someValue", arrayFieldName: [1, 2, 3], numberFieldName: 123 };
const response = validateAllFields(data, "customMessage");` | - Returns an object with errors like:
```{ fieldName1: "fieldName1 is required", fieldName2: "fieldName2 is required" }``` |
| `validateEmail` | Validates the format of an email address. | - `email` (the email address to validate)
- `userRegix` (Optional) | `const response = validateEmail(email, userRegix);` | - Returns: `true` if correct format.
- Returns: `false` if incorrect format. |
| `validatePhone` | Validates if the phone number format is correct. | - `phone` (the phone number to validate)
- `userRegix` (Optional) | `const response = validatePhone(phone, userRegix);` | - Returns: `true` if correct format.
- Returns: `false` if incorrect format. |
| `validateURL` | Validates if the URL format is correct. | - `url` (the URL to validate)
- `userRegix` (Optional) | `const response = validateURL(url, userRegix);` | - Returns: `true` if correct format.
- Returns: `false` if incorrect format. |
| `validatePassword` | Validates if the password format meets the required criteria (e.g., length, special characters). | - `password` (the password to validate)
- `userRegix` (Optional) | `const response = validatePassword(password, userRegix);` | - Returns: `true` if correct format.
- Returns: `false` if incorrect format. |
| `validateDate` | Validates if the date format is correct. | - `date` (the date to validate)
- `userRegix` (Optional) | `const response = validateDate(date, userRegix);` | - Returns: `true` if correct format.
- Returns: `false` if incorrect format. |
| `validateSingleMimeType` | Validates if a single file's MIME type is allowed. | - `file` (the file to check)
- `allowedTypes` (an array of allowed MIME types) | `const isValid = validateSingleMimeType(file, ['image/jpeg', 'image/png']);` | - Returns: `true` if MIME type is allowed.
- Returns: `false` if MIME type is not allowed. |
| `validateMimeTypes` | Validates the MIME types of multiple files. | - `files` (an array of files)
- `allowedTypes` (an array of allowed MIME types) | `const response = validateMimeTypes(files, ['image/jpeg', 'image/png']);` | - Returns an object with filenames and validity status:
```{ filename1: true, filename2: false }``` |
| `validateSingleFileSize` | Validates if a single file's size is within the allowed limit. | - `file` (the file to check)
- `maxSizeMB` (maximum allowed file size in MB) | `const isValid = validateSingleFileSize(file, 5);` | - Returns: `true` if file size is within limit.
- Returns: `false` if file size exceeds limit. |
| `validateFileSize` | Validates the sizes of multiple files. | - `files` (an array of files)
- `maxSizeMB` (maximum allowed file size in MB) | `const response = validateFileSize(files, 5);` | - Returns an object with filenames and validity status:
```{ filename1: true, filename2: false }``` |
| `addCustomValidator` | Adds a custom validation function to the store. | - `name` (name of the custom validator)
- `validatorFunction` (function to validate) | `addCustomValidator('customName', customFunction);` | - No return value. Adds a custom validator to the store. |
| `validateWithCustom` | Validates a value using a custom validator from the store. | - `name` (name of the custom validator)
- `value` (value to validate)
- `...args` (additional arguments) | `const response = validateWithCustom('customName', value, ...args);` | - Returns the result of the custom validator function.