npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vdjs

v2.0.0

Published

A simple JavaScript data validation library.

Downloads

51

Readme

vdjs

A JavaScript data validation library.

usage

npm i vdjs
const vdjs = require('vdjs')

vdjs.validate(data, rules).then(res => {
  if (res.fails()) alert(res.message)
})

API

  • vdjs.validate(data, rules) 返回 Promise<analyzerResult>

analyzerResult:

type analyzerResult = {
  valid: { [key: string]: validRuleResult },
  fails: () => boolean,
  message: (isAll?: boolean) => string | string[]
}

rules

列出需要验证的 ruleType,信息可以是 message 或者 msg

{
  key: { required: true, msg: 'Required `:attr`' },
  key2: [
    { required: true, msg: 'Required `:attr`' },
    { length: 10, msg: '`:attr` must be :ruleValue' },
  ],
  key2: { required: true, length: [6, 10], msg: 'Invalid parameters' },
}

ruleType

支持的规则如下:

type ruleReturn = boolean | Promise<boolean>
type ruleValidator = (value: any) => ruleReturn
type variableType = 'string' | 'object' | 'array' | 'boolean' | 'number' | 'null' | 'undefined' | 'symbol' | 'NaN'

export interface ruleType {
  [key: string]: any;
  message?: string;
  msg?: string;

  /**
   * 必须的,非 undefined 则返回 true
   * **/
  required?: (value: any, ruleValue: boolean) => ruleReturn;

  /**
   * 自定义验证
   * **/
  validator?: (value: any, ruleValue: ruleValidator) => ruleReturn;

  /**
   * 等于 ===
   * **/
  eq?: (value: any, ruleValue: any) => ruleReturn;

  /**
   * 不等于 !==
   * **/
  not?: (value: any, ruleValue: any) => ruleReturn;

  /**
   * 类型判断
   * **/
  type?: (value: any, ruleValue: variableType) => ruleReturn;

  /**
   * 数值最小值,>=
   * **/
  min?: (value: any, ruleValue: number) => ruleReturn;

  /**
   * 数值最大值,<=
   * **/
  max?: (value: any, ruleValue: number) => ruleReturn;

  /**
   * 比较 >
   * **/
  gt?: (value: any, ruleValue: any) => ruleReturn;

  /**
   * 比较 >=
   * **/
  gte?: (value: any, ruleValue: any) => ruleReturn;

  /**
   * 比较 <
   * **/
  lt?: (value: any, ruleValue: any) => ruleReturn;

  /**
   * 比较 <=
   * **/
  lte?: (value: any, ruleValue: any) => ruleReturn;

  /**
   * 长度
   * **/
  length?: (value: any, ruleType: number | [number, number]) => ruleReturn;

  /**
   * 在范围之内
   * **/
  between?: (value: any, ruleValue: [any, any]) => ruleReturn;

  /**
   * 不在范围之内
   * **/
  notBetween?: (value: any, ruleValue: [any, any]) => ruleReturn;

  /**
   * 在里面,支持数组,字符,对象
   * **/
  in?: (value: any, ruleValue: any[] | string | object) => ruleReturn;

  /**
   * 不在里面,支持数组,字符,对象
   * **/
  notIn?: (value: any, ruleValue: any) => ruleReturn;

  /**
   * 符合正则
   * **/
  math?: (value: any, ruleValue: RegExp) => ruleReturn;

  /**
   * 不符合正则
   * **/
  notMath?: (value: any, ruleValue: RegExp) => ruleReturn;

  /**
   * 相似
   * **/
  like?: (value: any, ruleValue: string) => ruleReturn;

  /**
   * 非相似
   * **/
  notLike?: (value: any, ruleValue: string) => ruleReturn;

  /**
   * 匹配邮箱
   * **/
  email?: (value: any, ruleValue: RegExp | boolean) => ruleReturn;

  /**
   * true 时验证空,false时验证非空;'', null, undefined, [], {}, NaN
   * **/
  empty?: (value: any, ruleValue: boolean) => ruleReturn;
}