0.1.1 • Published 4 years ago

noregex v0.1.1

Weekly downloads
3
License
ISC
Repository
github
Last release
4 years ago

noRegex

Build Status npm version dependencies Status

noRegex is a lightweight javascript library with no dependencies, made for those who don't want to blow their mind with regex syntax.
noRegex do not replace regex, it only simplify basic needs to validate what's inside a string, but do not test a pattern.

Install:

npm i noregex

Usage example:

var myTest = new noRegex({
    acceptNumbers: false,
    length: {
        min: 5
    },
    specialRules: {
        forbiddenChars: '().#'
    }
});
myTest.test(myString);
myTest.format(myString);

Methods:

  • test(str): Test if the given string match options, return boolean.
  • format(str): Remove or replace all characters from the given string that does not match options, return formatted string.

Options:

All options with their default values:

{
    acceptStrings: true,
    acceptNumbers: true,
    acceptUppercase: true,
    acceptLowercase: true,
    acceptAccents: true,
    acceptSpecialChars: true,
    acceptWhiteSpaces: true,
    specialRules: {
        allowedChars: undefined, //case-sensitive
        forbiddenChars: undefined //case-sensitive
    },
    length: {
        min: undefined,
        max: undefined,
        equals: undefined
    },
    affix: {
        startsWith: undefined, //case-sensitive
        endsWith: undefined //case-sensitive
    }
}

Example of options usage:

{
    acceptStrings: true,
    acceptNumbers: true,
    acceptUppercase: false,
    acceptLowercase: true,
    acceptAccents: false,
    acceptSpecialChars: false,
    acceptWhiteSpaces: false,
    specialRules: {
        allowedChars: '-_?=',
        forbiddenChars: '0.#'
    },
    length: {
        min: 12,
        max: 250
    },
    affix: {
        startsWith: 'https://',
        endsWith: '.js'
    }
}

Modify default options:

noRegex.DEFAULT.acceptAccents = false;