Validation

Lightweight, flexible and typesafe form validator.

Install

npm i ab-validation

Import

import { Validation, FormValidation, createValidator } from "ab-validation"

Validation

Validate a single input.

Parameters:
name: string
validators: ValidatorSchema[]

Return:
{ validate, subscribe }

validate: (value: unknown) => Promise<void | ValidationState>
subscribe: ((state: ValidationState) => void) => () => void

Sample Usage

import { Validation, Required } from "ab-validation"

const name = Validation("name", [Require("Name is required")])

name
  .validate("John")
  .then(() => console.log("Valid"))
  .catch((result) => console.log(result))
// { name: "name", error: "required", message: "Name is required" }

Subscribe to a Validation

const { validate, subscribe } = Validation("name", [
  Required("Name is required."),
])

const unsubscribe = subscribe((state) => {
  console.log(state)
})

validate("John")
unsubscribe()

FormValidation

Validate multiple inputs.

Parameters:
validations: Validation[]

Return:
{ validate, subscribe }

validate: (value: unknown) => Promise<void | FormValidationState>
subscribe: ((state: FormValidationState) => void) => () => void

Sample Usage

import { FormValidation, Validation, Required, Email } from "ab-validation"

const form = FormValidation([
  Validation("name", [Required("Please enter the name.")]),
  Validation("email", [
    Required("Please enter the email."),
    Email("Email is incorrect."),
  ]),
])

form
  .validate({
    name: "John",
    email: "john@gmail",
  })
  .then(() => console.log("Valid"))
  .catch((result) => console.log(result))
// [{name: "email", error: "pattern", message: "Email is incorrect."}]

createValidator

It's a higher order function to create a validator schema.

createValidator<OptionsType>(error, resolver)

Parameters:
error: string resolver: (value?: unknown, options?: object) => boolean | Promise<void | boolean>

Return:
Validator-

Built-in Validators

| Validator | Description | Options | |-----------|-------------|------------| | Required | Return true if value is not empty. |{}| | Text | Valid if the text's length is between minimum and maximum length.|{ minLength?: number, maxLength?: number }| |Email|Check if the value is a valid email address.|{}| |List|Valid if the list includes the value.|{ items: unknown[] }| |Pattern|Matchs RegEx pattern with the value|{ regex: RegExp }|

Async validator

import { Validation, createValidator } from "ab-validation"

interface UsernameExistsOptions {}

const UsernameExists = createValidator<UsernameExistsOptions>(
  "username-exists",
  async (value: string) => {
    const data = await fetch(`api/user/${value}`).then((response) =>
      response.json()
    )

    return !data.user
  }
)

const username = Validation("username", [UsernameExists("Username already exists.")])
username.validate("arian")