\r\n\r\n# Validator Toolkit\r\n\r\nA comprehensive toolkit for data validation in JavaScript.\r\n\r\n## Description\r\n\r\nValidator Toolkit provides a set of tools and utilities to validate various types of data, including strings, numbers, arrays, and objects. Whether you're building a web application, API, or any other software that deals with user input, Validator Toolkit can help ensure that your data meets the required criteria.\r\n\r\n## Installation and Usage\r\n\r\n### Server-side\r\n\r\nTo install Validator Toolkit using npm, run the following command:\r\n\r\n```bash\r\nnpm install ds-validator-toolkit\r\n```\r\n\r\n## Browser Usage (ESM)\r\n\r\nYou can use Validator Toolkit directly in the browser without installing it by importing the desired functions from the unpkg.com CDN:\r\n\r\n```html\r\n\r\n```\r\n\r\n## ES6 Modules\r\n\r\nIf you're using ES6 modules in your project, you can import the desired functions from the package:\r\n\r\n```javascript\r\nimport {\r\n _STR_,\r\n VALIDATE_STRING,\r\n} from \"./node_modules/ds-validator-toolkit/dist/index.mjs\";\r\n```\r\n\r\nAdd this line in your html file\r\n\r\n```html\r\n\r\n```\r\n\r\n## Webpack Integration\r\n\r\nIf you're using Webpack, you can easily integrate Validator Toolkit into your project. Follow these steps:\r\n\r\n1- Initialize a new npm project using:\r\n\r\n```bash\r\nnpm init -y\r\n```\r\n\r\n2- Install the required dependencies:\r\n\r\n```bash\r\nnpm install webpack webpack-cli babel-loader @babel/core @babel/preset-env --save-dev\r\n```\r\n\r\n3-Create a webpack.config.js file with the following configuration:\r\n\r\n```javascript\r\n\r\nconst path = require('path');\r\n\r\nmodule.exports = {\r\n entry: './src/index.js',\r\n output: {\r\n path: path.resolve(__dirname, 'dist'),\r\n filename: 'bundle.js',\r\n },\r\n module: {\r\n rules: [\r\n {\r\n test: /\\.(js|jsx)$/,\r\n exclude: /node_modules/,\r\n use: {\r\n loader: 'babel-loader',\r\n options: {\r\n presets: ['@babel/preset-env'],\r\n },\r\n },\r\n },\r\n ],\r\n },\r\n};\r\n\r\n\r\n```\r\n\r\n4- Create a src folder and an index.js file within it. You can import the desired functions from the package in this file:\r\n\r\n```javascript\r\nimport { _STR_, VALIDATE_STRING } from \"ds-validator-toolkit\";\r\n```\r\n\r\n5- In your HTML file, include the bundled JavaScript file:\r\n\r\n```html\r\n\r\n```\r\n\r\n6- Run npm run build to generate the bundled JavaScript file (dist/bundle.js).\r\n\r\n> With these steps, you should be able to use Validator Toolkit in your Webpack project.\r\n\r\n### Example 1: `Using VALIDATE_STRING`\r\n\r\nHere's an example demonstrating the VALIDATE_STRING function with various options:\r\n\r\n```javascript\r\nconst name = \"Chloe\";\r\nconst result = VALIDATE_STRING(name, {\r\n // Options\r\n isRequired: true,\r\n minStringLength: 10,\r\n maxStringLength: 20,\r\n // ...\r\n\r\n // Error Messages\r\n isStringError: \"Input must be a string.\",\r\n lengthError: \"Input length must be between 10 and 20 characters.\",\r\n // ...\r\n});\r\n\r\nconsole.log(result); // { isValid: false, message: \"Input length must be between 10 and 20 characters.\" }\r\n```\r\n\r\nThis example showcases the VALIDATE_STRING function with the specified options and custom error messages.\r\n\r\n### Example 2: Using _STR_ Class\r\n\r\n```javascript\r\nconst name = \"flower\";\r\n\r\n// Check if the string is required\r\n_STR_.isRequired(name, true);\r\n\r\n// Check if the string contains blacklisted words\r\nconst result = _STR_.containsBlacklistedWord(name, [\"flower\", \"garden\"]);\r\n\r\nconsole.log(result); // { isValid: false, message: \"Name contains blacklisted words.\" }\r\n```\r\n\r\nThe _STR_ class provides various functions for string validation, making it easy to perform specific checks on strings.\r\n\r\n## What's New\r\n\r\navailable options:\r\n\r\n> isRequired,\r\n> maxValue,\r\n> minValue,\r\n> isInteger,\r\n> allowNegative = true,\r\n> allowPositive = true,\r\n> allowZero = true,\r\n> onlyDecimal,\r\n> maxDecimalPlaces,\r\n> minDecimalPlaces,\r\n> allowExponent,\r\n> onlyBinary\r\n> thousandSeperator\r\n> customThousandSeperator\r\n> customValidationFn (NEW!!!)\r\n\r\n# Future\r\n\r\n> allowCurrencySymbol\r\n\r\n## Validators\r\n\r\nHere is a list of the validators currently available.\r\n\r\n| Validator | Description |\r\n| --------------------------------------- | ----------------------------------------------- |\r\n| **VALIDATE_STRING(string, option= {})** | validate string based on built in option |\r\n| **_STR_ : class** | a class that provide String validation function |\r\n| | |\r\n| **VALIDATE_NUMBER(string, option= {})** | validate number based on built in option |\r\n| **_NUM_ : class** | a class that provide number validation function |\r\n","readmeFilename":"README.md","description":"
![\"Logo\"](\"https://raw.githubusercontent.com/daniseifeddine/Ds-Validator-Toolkit/main/media/logo.png\"){kind=logo}
\r