valid-utils v1.0.1

Welcome to Valid Utils

A simple and flexible validation package for common data types and formats, including email, URLs, dates, numbers, and more.

Installation

npm install valid-utils

Usage

import React, { useState } from "react";

// Assuming `isItValidPass` is imported from your utility file
import { isItValidPass } from "valid-utils";

const PasswordValidator: React.FC = () => {
  const [password, setPassword] = useState<string>("");
  const [validationResult, setValidationResult] = useState<string | null>(null);

  const validatePassword = () => {
    const options = {
      minLength: 8,
    };

    const { result, isValid } = isItValidPass(password, options);

    if (isValid) {
      setValidationResult("Password is valid");
    } else {
      setValidationResult(`Password is invalid: ${result}`);
    }
  };

  return (
    <div>
      <input
        type="password"
        value={password}
        onChange={(e) => setPassword(e.target.value)}
        placeholder="Enter your password"
      />
      <button onClick={validatePassword}>Validate Password</button>
      {validationResult && <p>{validationResult}</p>}
    </div>
  );
};

export default PasswordValidator;

Available Validation Functions

isItValidEmail

Validates an email address based on various customizable options.

• Parameters:
  • email (string): The email address to validate.
  • options (optional EmailOptions): Optional configuration for the validation process.
• Returns: { isValid: boolean, result: string }

isItValidPass

Validates a password based on various customizable options.

• Parameters:
  • password (string): The password to validate.
  • options (optional PasswordOptions): Optional configuration for the validation process.
• Returns: { isValid: boolean, result: string }

isItValidDate

Validates a date based on a specified format.

• Parameters:
  • date (string): The date to validate.
  • format (string): The date format to validate (e.g., "YYYY-MM-DD", "MM/DD/YYYY", "DD/MM/YYYY").
• Returns: { isValid: boolean, result: string }

isItValidNumber

Validates a numeric input based on various customizable options.

• Parameters:
  • value (number | string): The number to validate.
  • options (optional NumericOptions): Optional configuration for the validation process.
• Returns: { isValid: boolean, result: string }

isItValidUrl

Validates a URL based on various customizable options.

• Parameters:
  • url (string): The URL to validate.
  • options (optional UrlOptions): Optional configuration for the validation process.
• Returns: { isValid: boolean, result: string }

Type Definitions

ResponseShape

The shape of the response returned by validation functions.

GlobalOptions

Global options that apply to various validation functions.

EmailOptions

Options specific to email validation.

PasswordOptions

Options specific to password validation.

NumericOptions

Options specific to numeric validation.

UrlOptions

Options specific to URL validation.

AllowedProtocols

This type defines the allowed protocols for URLs.

Contributing

There are many different ways to contribute to React Router's development. If you're interested, check out our contributing guidelines to learn how you can get involved.