@fireflysemantics/validator

Typescript Validation Decorators and Executor

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
79Jun 4, 2021Jun 21, 2018Minified + gzip package size for @fireflysemantics/validator in KB

Readme

Build Status

Validator

Validator

Typescript Validation Decorators and Executor. See API for all methods provided.

Install

npm i -S @fireflysemantics/validator

Install @fireflysemantics/validator peer dependencies along with the library:

npm i -S @fireflysemantics/validatorts
npm i -S @fireflysemantics/is

Note that if you are using the FESM5 package format the tslib peer dependency must also be installed.

npm i -S npm i tslib

Typedoc

Typedoc Documentation

Features

  • Progressive validation (Only check if the date is valid if the property is non null)
  • Cross property validation (Does the start date come before the end date?)
  • Cross Property Conditional Validation with @IfValid stops cross property validation a dependent property is invalid.
  • Access to the entire ValidationContext enabling the customization of validation messages post validation
  • Executes the decorators is a predictable ordered sequence

The following decorators:

  • IfValid
  • IsAfterInstant
  • IsAlpha
  • IsAlphaNumeric
  • IsArray
  • IsArrayContainerOf
  • IsArrayIn
  • IsArrayNotEmpty
  • IsArrayNotIn
  • IsArraySizeGreaterThan
  • IsArraySizeLessThan
  • IsArrayUnique
  • IsAscii
  • IsBase64
  • IsBeforeInstant
  • IsBoolean
  • IsBooleanString
  • IsByteLength
  • IsCreditCard
  • IsCurrency
  • IsDate
  • IsDefined
  • IsDivisibleBy
  • IsEmail
  • IsEmpty
  • IsEnum
  • IsEqualTo
  • IsFQDN
  • IsFullWidth
  • IsGreaterThan
  • IsHalfWidth
  • IsHexColor
  • IsHexadecimal
  • IsIP
  • IsISBN
  • IsISIN
  • IsISODateString
  • IsInRange
  • IsInstanceOf
  • IsInt
  • IsJSON
  • IsLengthGreaterThan
  • IsLengthLessThan
  • IsLessThan
  • IsLowercase
  • IsMilitaryTime
  • IsMobilePhone
  • IsMongoID
  • IsMultibyte
  • IsNegative
  • IsNotEmpty
  • IsNotEqualTo
  • IsNotSubString
  • IsNotSuperString
  • IsNumber
  • IsNumberString
  • IsPatternMatch
  • IsPositive
  • IsSameInstant
  • IsString
  • IsSubString
  • IsSuperString
  • IsSurrogatePair
  • IsURL
  • IsUUID
  • IsUpperCase
  • IsValueIn
  • IsValueNotIn
  • IsVariableWidth

Use Cases

Progressive Validation

See this article for an overview of how progressive validation works.

There's also a Stackblitz demo here.

Cross Property Conditional Validation

In some cases we want to validate something else only when a corresponding property on the instances is valid. For example:

class GreaterThanCheck { 
     @IsNumber
     firstNumber: any = null;

     @IsGreaterThan("firstNumber")
     @IsNumber()
     @IfValid('firstNumber)
     secondNumber = 22; 
}

In this case the validation of secondNumber depends on the first number. Thus in order to minimize validation noise, we would like to validate the secondNumber only if the first number is valid. The @IfValid('firstNumber) ensures that this will be the case.

Runtime

This assumes a minimum ES2017 runtime environment. Use core.js if you think the code will run in non compliant runtimes. We use Object.values, which has an ES2017 a minimum runtime.

Build

Run npm run c to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with npm run p

Running unit tests

Run npm t to execute the unit tests via Jest.

Supported Package Formats

The library is built with the Angular Package Format. It therefore supports all these package formats (As can be seen in the provided package.json) and has integrated typescript definitions:

  • "main": "bundles/fireflysemantics-validatorts.umd.js",
  • "module": "fesm5/fireflysemantics-validatorts.js",
  • "es2015": "fesm2015/fireflysemantics-validatorts.js",
  • "esm5": "esm5/fireflysemantics-validatorts.js",
  • "esm2015": "esm2015/fireflysemantics-validatorts.js",
  • "fesm5": "fesm5/fireflysemantics-validatorts.js",
  • "fesm2015": "fesm2015/fireflysemantics-validatorts.js",
  • "typings": "fireflysemantics-validatorts.d.ts"

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.