VALGEN

Fast runtime type validator, converter and io (encoding/decoding) library for TypeScript and JavaScript.

• Composable - build complex schemas out of small validators with allOf, oneOf, pipe, optional, nullable, isObject, isArray, ...
• Coercing - most rules can convert compatible input ("42" -> 42, "true" -> true, ...) instead of just rejecting it, via the coerce option.
• Two calling conventions - call a validator directly and catch a ValidationError, or use .silent(...) to get back { value } / { errors } without throwing.
• Typed - every validator infers its output type, so a passing call narrows the type of its return value.
• Fast - the core dispatch path and every rule are covered by a dedicated benchmark suite (see Benchmarking below); performance regressions are something this project actively measures, not just hopes for.

Installation

npm install valgen --save

Quick start

import { vg, isEmail, ValidationError } from 'valgen';

// Individual, ready-to-use validators
isEmail('[email protected]'); // => '[email protected]'
isEmail('not-an-email'); // throws ValidationError

// A full object schema, built from composable rules
const userSchema = vg.isObject({
  id: vg.isUUID(),
  email: vg.isEmail(),
  age: vg.optional(vg.pipe([vg.isNumber({ coerce: true }), vg.isGt(0)])),
  role: vg.isEnum(['admin', 'user']),
});

try {
  const user = userSchema({
    id: 'e6a3b1c0-70b6-4a3e-9b34-1e2f2e3d1a11',
    email: '[email protected]',
    age: '30', // coerced to a number
    role: 'admin',
  });
} catch (e) {
  if (e instanceof ValidationError) {
    console.error(e.issues); // one entry per failing field
  }
}

// Or avoid the try/catch entirely
const result = userSchema.silent({ email: 'not-an-email' });
if (result.errors) {
  // result.errors: ErrorIssue[]
}

Documentation

The full API reference lives under docs/:

• API overview - the Validator shape, .silent(), pre-built instances vs. factories, ExecutionOptions, error shape, composition patterns, and how to write a custom rule.
• Type Rules - isString, isNumber, isObject, isArray, isTuple, isEnum, isDate, isRecord, isInstanceOf, ...
• Logical Rules - isEqual, isGt/isGte/isLt/isLte, range, lengthMin/lengthMax, isEmpty/isNotEmpty, isDefined.
• Utility Rules - allOf, oneOf, pipe, optional, nullable, required, fixed, getLength, forwardRef, iif, string helpers.
• Format Rules - isEmail, isURL, isUUID, isIBAN, isMACAddress, isCreditCard, and every other string-format check.

Scripts

| Command | Description | |---|---| | npm test | Run the test suite (mocha). | | npm run citest | Run the test suite with coverage (c8). | | npm run qc | Lint + circular-dependency check. | | npm run bench | Run the benchmark suite (see below). | | npm run build | Type-check and compile to build/. |

Benchmarking

Every validator rule has a dedicated benchmark case measuring throughput (ops/sec) and per-call memory allocation (heap/RSS), under benchmark/rules/.

# Run every rule
npm run bench

# Run one or more rules (case-insensitive, comma-separated, "*" wildcards allowed)
npm run bench -- -s isEmail,isURL
npm run bench -- -s "is*"

Results print to the console as they complete and are also written to BENCHMARKS.md at the end of the run.

Node Compatibility

• node >= 20.0

License

MIT