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

@newtral/class-validator

v5.0.3

Published

Decorator based validation augmenting the class-validator module

Downloads

209

Readme

@newtral/class-validator

Install

npm install @newtral/class-validator class-validator

Usage

@IsOptional()

Validate when the original value is not undefined. Unlike the class-validator one that allows both null and undefined

import { IsString, validateSync } from 'class-validator';
import { IsOptional } from '@newtral/class-validator';

class User {
  @IsOptional()
  @IsString()
  name?: string;

  constructor(name?: string) {
    this.name = name;
  }
}

const errors = validateSync(new User());
console.log(errors.length); // 0

@IsObjectId()

Validate the value is a valid object id. Could be numeric, string or another object id. It could useful to pair with the ToObjectId transformer in order to always convert to an object id instance

import { IsString, validateSync } from 'class-validator';
import { IsOptional } from '@newtral/class-validator';
import { ObjectId } from 'mongo';

class User {
  @IsObjectId()
  _id?: string | number | ObjectId;
}

Development

The project use husky and lint-staged for linting and fixing possible errors on source code before commit

Git hooks scripts are installed after running npm install the first time

npm run build:commonjs

Compile typescript files from the src folder inside the lib folder

npm run build:esm

Compile typescript files from the src folder inside the esm folder using es modules

npm run build

Concurrently run both build:commonjs and build:esm

npm run clean

Remove the following directories/files

  • lib
  • esm
  • reports

npm test

Run tests files inside the tests folder that matches the following patterns. Exit with code > 0 on error

  • *.test.ts
  • *.spec.ts

npm run cover

The same as npm test and generates coverages reports in reports/coverage. Exit with code > 0 on error

npm run lint

Check eslint errors according to .eslintrc

npm run lint:fix

Run npm run lint applying fixes and run prettier on every typescript file

npm run health

Check for:

  • Build errors
  • Tests failures
  • Lint errors

npm run ci

Run test and generate every possible report. Do not exit with error code > 0 if the tests fail. It generates a report file instead

  • reports/lint-checkstyle.xml Lint report in chackstyle format
  • reports/test-results.xml Test report in xUnit format
  • reports/coverage/clover.xml Coverage report in clover format
  • reports/coverage/cobertura-coverage.xml Coverage report in cobertura format
  • reports/coverage/lcov.info Coverage report in lcov
  • reports/coverage/index.html Coverage report in html