New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More

abolish

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

abolish

A javascript object validator.


Version published
Weekly downloads
60
decreased by-28.57%
Maintainers
1
Weekly downloads
 
Created

Abolish

A Javascript object validator for custom validations

Documentation: Abolish Documentation
Playground: Abolish Playground

Basic Example

const {Abolish} = require('abolish');

const abolish = new Abolish();

// Use abolish email validator
const EmailValidator = require('abolish/validators/string/email');
abolish.addValidator(EmailValidator);

// Add Custom Validtor
abolish.addValidator({
  name: 'addProtocol',
  validator: (url, option, {modifier}) => {
    // Check if url does not have required protocol
    if (url.substring(0, option.length) !== option) {
      // Add protocol
      modifier.setThis(`${option}://${url}`)
    }
    return true
  }
});

// Object to validate
const form = {
  email: 'appdeveloper@sky.com',
  username: 'john_doe',
  age: 18,
  url: 'wildstream.ng'
};

const [error, validated] = abolish.validate(form, {
  $: 'required|typeOf:string', // $ or '*' is considered as wildcard
  email: 'isEmail',
  username: '*',
  age: 'typeOf:number|max:20',
  url: 'addProtocol:http'
});

console.log({form, validation: {error, validated}});
Result
{
  form: {
    email: 'appdeveloper@sky.com',
    username: 'john_doe',
    age: 18,
    url: 'wildstream.ng'
  },
  validation: {
    error: null,
    validated: {
      email: 'appdeveloper@sky.com',
      username: 'john_doe',
      age: 18,
      url: 'http://wildstream.ng'
    }
  }
}

FAQs

Package last updated on 08 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts