@types/validator

What is @types/validator?

The @types/validator package provides TypeScript type definitions for the validator.js library, which is a tool for string validation and sanitization. This package does not contain functionality by itself but offers type support for TypeScript users of validator.js, enabling them to utilize the library in a type-safe manner.

What are @types/validator's main functionalities?

Email Validation

This feature allows you to validate whether a string is a valid email address.

import validator from 'validator';

const email = '[e-mail]';
const isValidEmail = validator.isEmail(email);
console.log(isValidEmail); // true or false

URL Validation

This feature enables you to check if a string is a valid URL.

import validator from 'validator';

const url = 'https://www.example.com';
const isValidUrl = validator.isURL(url);
console.log(isValidUrl); // true or false

Sanitize Data

This feature allows you to sanitize input to prevent XSS attacks by escaping HTML characters.

import validator from 'validator';

const dirtyString = '<script>Alert('XSS')</script>'; 
const cleanString = validator.escape(dirtyString);
console.log(cleanString); // '&lt;script&gt;Alert(&#x27;XSS&#x27;)&lt;/script&gt;'

Other packages similar to @types/validator

joi

Joi is a powerful schema description language and data validator for JavaScript. Unlike @types/validator, which provides type definitions for validator.js, Joi offers a comprehensive API for validating JavaScript objects. It's more suited for object schema validation and can be used both on the client and server side.

yup

Yup is a JavaScript schema builder for value parsing and validation. It defines a schema with a more expressive and less verbose syntax compared to traditional assertion libraries. While @types/validator provides TypeScript support for validator.js, Yup offers both validation functionality and its own type definitions, making it a standalone choice for projects.

README

Installation

npm install --save @types/validator

Summary

This package contains type definitions for validator.js (https://github.com/validatorjs/validator.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/validator.

Additional Details

• Last updated: Sat, 24 Sep 2022 20:32:57 GMT
• Dependencies: none
• Global values: validator

Credits

These definitions were written by tgfjt, Ilya Mochalov, Ayman Nedjmeddine, Louay Alakkad, Bonggyun Lee, Naoto Yokoyama, Philipp Katz, Jace Warren, Munif Tanjim, Vlad Poluch, and Piotr Błażejewicz.