NPMGithub

Username

Validating Username is rather simple but time consuming task, valid8r Username validators provides a handful of options to best suit your validation requirements

Valid8r covers all the basic as well as advanced Username validations that covers 99% edge cases

Start by importing valid8r into your file:

import valid8r from '@c4code/valid8r';

Configuration Options

Valid8r username validator provides handful of options to best meet your requirements and validation needs, the options that can be configured in username validator are:

import valid8r from '@c4code/valid8r';

const username: string = "jo#n_sm1th";

// The configuration can be defaulted globally
valid8r.username(username, {
  safe: false, // boolean
  minLen: 3, // number
  maxLen: 30, // number
  allowNumbers: true, // boolean
  allowUnderscores: true, // boolean
  allowDashes: true, // boolean
  allowSpecialChars: false, // boolean | string[]
  allowSpaces: false, // boolean
  allowUppercase: true, // boolean
  throwErrorsAs: "throw-all", // "throw-first" | "throw-last" | "throw-all",
  /*
  "throw-first" => Throws or returns the first error encountered,
  "throw-last" => Throws or returns the last error encountered,
  "throw-all" => Throws or returns all errors in a Array of string
  */
}); // the second argument is optional

The allowedSpChars field accepts special characters which are allowed to be included in the address, it accepts a array of special characters like:

allowedSpChars: [',', '#']; // Accepts these sp. characters only
// or
allowedSpChars: true // Allows all

The allowedSpChars is by default set to false, i.e it will not accept any special characters by default

The Configuration can be globally set for all the validators in your project, know more?

Basic Usage

Here's how we can use the username validator in it's most basic manner:

Start by importing valid8r:

import valid8r from '@c4code/valid8r';
import valid8r from '@c4code/valid8r';

const username: string = "jo#n_sm1th";

// The configuration can be defaulted globally
valid8r.username(username); // throws UsernameValidation error as sp. chars are not allowed

Safe handling

By default, all the validations in valid8r works on unsafe flag, meaning if any of the validation fails it will throw an Error.

However, if you don't want it to throw any error but return them. set the safe flag to true.

import valid8r from '@c4code/valid8r';

const username: string = "jo#n_sm1th";

// The configuration can be defaulted globally
const [isValid, errors] = valid8r.username(username, {
    safe: true
});

if (!isValid) {
    console.log(errors);
        // [{ allowSpecialChars: "Username cannot contains special characters, other than ." }]
}

Error Messages

If you don't like the default error message and want to set a custom error message for any specific fields, pass an object as a third argument of the username function:

import valid8r from '@c4code/valid8r';

const username: string = "jo#n_sm1th";

// The configuration can be defaulted globally
const [isValid, errors] = valid8r.username(username, {
    safe: true
}, {
    allowSpecialChars: "No Special Chars"
});

if (!isValid) {
    console.log(errors);
        // [{ allowSpecialChars: "No Special Chars" }]
}

Error Message Options

Valid8r username validator provides handful of options to configure error messages to best fit your project requirements

import valid8r from '@bitbybit/valid8r';

const username: string = "jo#n_sm1th";

// The configuration can be defaulted globally
valid8r.username(username, { /* Field Configurations */ }, {
  format: 
    "Username's format is invalid!",
  minLen: 
    "Username must be at least {minLen} characters long.",
  maxLen: 
    "Username must not exceed {maxLen} characters.",
  allowNumbers: 
    "Username contains invalid numbers.",
  allowUnderscores: 
    "Username contains invalid underscores.",
  allowDashes: 
    "Username contains invalid dashes.",
  allowSpecialChars: 
    "Username cannot contains special characters, other than {allowSpecialChars}.",
  allowSpaces: 
    "Username cannot include spaces.",
  allowUppercase: 
    "Username cannot include uppercase letters.",
  customRegex: 
    "Username does not match the required format.",
}); // the second and third argument is optional

All the options are optional, if passed will be used as the configuration for that specific validator

The Error messages can be globally set for all the validators in your project, know more?

PreviousIP AddressNextDate

Last updated