# fogex > A JavaScript library for quickly and easily testing the validity or invalidity of a value. Latest version **0.0.29** (published 2024-05-04) · MIT license · 0 weekly downloads ## Install ```sh npm install fogex pnpm add fogex yarn add fogex bun add fogex ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.29 | | Published | 2024-05-04 | | First published | 2022-05-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=16.x | | Dependencies | 0 | | Unpacked size | 1.3 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 7 | | Author | ymzEmre | | Maintainers | ymzemre | | Keywords | regex, regular expression | ## Links - npm: https://www.npmjs.com/package/fogex - Repository: git:github.com/fogex-js/fogex - npm.io page: https://npm.io/package/fogex ## Recent versions - 0.0.29 (latest) — 2024-05-04 - 0.0.28 — 2024-05-01 - 0.0.27 — 2024-02-12 - 0.0.26 — 2024-02-09 - 0.0.25 — 2024-02-09 - 0.0.24 — 2024-02-09 - 0.0.23 — 2024-02-08 - 0.0.22 — 2024-02-08 - 0.0.21 — 2024-02-03 - 0.0.20 — 2024-02-02 - 0.0.19 — 2024-02-02 - 0.0.18 — 2024-02-02 - 0.0.17 — 2024-02-01 - 0.0.16 — 2024-01-29 - 0.0.15 — 2024-01-23 - … 9 more at https://npm.io/package/fogex/versions ## README # Fogex [![npm version](https://badge.fury.io/js/fogex.svg)](https://badge.fury.io/js/fogex) [![Coverage](https://img.shields.io/badge/coverage-96%25-gree)]() ## Table of Contents - [Introduction](#introduction) - [Installation](#installation) - [Usage](#usage) - [1) Pre-defined Validation Functions](#1-use-with-pre-defined-validation-functions) - [2) customPattern Function](#2-use-with-custompattern-function) - [3) GeneratorPattern Class](#3-use-with-generatorpattern-class) - [Pre-defined Regex Functions](#pre-defined-regex-functions) - [Contribution](#contribution) - [License](#mit-license) ## Introduction I abbreviated the expression "Form Regular Expression" as "FOGEX" to give the library its name. A JavaScript library for quickly and easily testing the validity or invalidity of a value. ## Installation ``` npm install fogex ``` ## Usage ### 1) Use with pre-defined validation functions `isEmail` ```JavaScript import { isEmail } from 'fogex' ``` ```JavaScript isEmail('test@test.com') // true isEmail('test@test') // false ``` `isPhoneNumber` ###### Use with parameter ```JavaScript import { isPhoneNumber } from 'fogex' ``` ```JavaScript isPhoneNumber('+11234567890', 'US') // true isPhoneNumber('1234567890', 'US') // true isPhoneNumber('+905555555555', 'US') // true isPhoneNumber('05555555555', 'US') // true isPhoneNumber('5555555555', 'US') // true ``` `isPin` ###### Use with parameter ```JavaScript import { isPin } from 'fogex' ``` ```JavaScript isPin('1234', '4') // true isPin('123456', '6') // true ``` `isCreditCard` ```JavaScript import { isCreditCard } from 'fogex' ``` ###### Default ```JavaScript // Accepts all card types isCreditCard('XXXX XXXX XXXX XXXX') // true isCreditCard('XXXXXXXXXXXXXXXX') // true ``` ###### Use with parameter ```JavaScript isCreditCard('XXXX XXXX XXXX XXXX', 'VISA') // true isCreditCard('XXXXXXXXXXXXXXXX', 'VISA') // true ``` ```JavaScript isCreditCard('XXXX XXXX XXXX XXXX', 'MASTER') // true isCreditCard('XXXXXXXXXXXXXXXX', 'MASTER') // true ``` ### 2) Use with `customPattern` function ```JavaScript import { customPattern } from 'fogex' ``` `a` => a-z `A` => A-Z `#` => 0-9 `!` => Special Characters `?` => Optional Characters Example ```JavaScript customPattern('aA#!', 8, 'aA1!1234') //true customPattern('aA?#!', 5, 'aa11\*') // true ``` ### 3) Use with `GeneratorPattern` Class ```JavaScript import { GeneratorPattern } from 'fogex' ``` ```JavaScript const value = 'qweR123!' const options = { minLength: 6, maxLength: 12, lowerCase: true, upperCase: true, number: true, specialCharacter: true, } const validator = new GeneratorPattern(options) const isValid = validator.validate(value) console.log(isValid) // true ``` ## Pre-defined Regex Functions | Tables | Description | Parameter | | ----------------------------- | :------------------------------------------------------------------------------------ | ----------------------------------- | | isAscii | Check if the string contains ASCII chars only. | | isBoolean | Check if a string is a boolean. | | isCase(val, case) | Check if the string is a cases. | `lower`, `upper`, `camel`, `pascal` | | isColorCode(val, colorCode) | Check if the string is a color code. | `rgb`, `hex`, `hsl` | | isCreditCard(val, cardType) | Check if the string is a credit card number. The default value accepts all card types | `VISA` or `MASTER` | | isEmail | Check if the string is an email. | | isFloat | Check if the string is a float. | | isHash | Check if the string is a hash of type | | isHour(val, hourFormat) | Check if the hour format is an correct. | `12` or `24` | | isIdentityNumber(val, locale) | Check if the string is a identity number. | `US` or `TR` | | isImageUrl(val, extension) | Check if the string is a image url. The default value accepts all image extension | `png`, `jpg`, `jpeg`, `gif` | | isImei | Check if check if the string is a valid IMEI number. | | isInteger | Check if the string is an integer. | | isIp | Check if the string is an IP | | isISBN | Check if the string is an ISBN. | | isMac | Check if the string is a MAC address. | | isMd5 | Check if the string is a MD5 hash. | | isMongoId | Check if the string is a valid a MongoDB ObjectId. | | isMonth | Check if the string is a month. | | isPassword | Check if a password is strong or not. | | isPhoneNumber(val, locale) | Check if the string is a mobile phone number. | `US` or `TR` | | isPin(val, length) | Check if the string is a pin. | `4` or `6` | | isPlate(val, locale) | Check if string the format of a plate format. | `US` or `TR` | | isPort | Check if the string is a valid port number. | | isPostalCode(val, locale) | Check if the string is a postal code number. | `US` or `TR` | | isString | Check if string of a letter | | isWhiteSpace | Check if the string contains white space. | ## Contribution Fogex library is under development, and is open to suggestions and contributions. It is publicly open for any contribution. Bug fixes, new features and extra modules are welcome. To contribute to code: Fork the repo, push your changes to your fork, and submit a pull request. To report a bug: Please report it using GitHub Issues. ## MIT License Copyright (c) 2022 Emre Yilmaz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --- _Source: https://npm.io/package/fogex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._