aurelia-validatejs
TypeScript icon, indicating that this package has built-in type declarations

0.7.0 • Public • Published

aurelia-validatejs

npm Version ZenHub Join the chat at https://gitter.im/aurelia/discuss CircleCI

This library is an implementation of the Validator interface found in the aurelia-validation library. Besides implementing the necessary abstractions of aurelia-validation, it also extends these capabilities by including both fluent and decorator-based APIs for defining rules for your components and data. The validation capabilities of this library are based on validatejs, an existing, open-source validation library.

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions, please join our community on Gitter. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards. You can get an overview of all Aurelia work by visiting the framework board.

*** WARNING ***

The docs below are for an earlier version of this package. The validation and validatejs plugins are undergoing an overhaul and are currently in alpha. Expect Changes. The best docs we have for the alpha at this time are here: http://blog.durandal.io/2016/06/14/new-validation-alpha-is-here/

OLD DOCS:

TypeScript Users

At the moment, validate.js doesn't have an official d.ts file. We've created one for you while we wait. You can find our d.ts file at lib/validatejs.d.ts.

Validation Rules

Validation is performed using validate.js. You can visit their official site to get more information about how to use all of the validation rules.

You can use a decorator or the fluent syntax, both are shown. Here are the base rules -

Date

Ensure it is a date

export class Model {
  @date myDate = new Date();
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('myDate')
        .date();
  }
}

Datetime

Ensure it is a datetime

export class Model {
  @datetime myDate = new Date();
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('myDate')
        .datetime();
  }
}

Email

Ensure it is a valid e-mail format

export class Model {
  @email email = 'patrick@example.com';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('email')
        .email();
  }
}

Equality

Ensure it matches another property on the same object

export class Model {
  @equality('password') confirmPassword = 'password1';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('confirmPassword')
        .equality('password');
  }
}

Exclusion

Disallow a set of values

export class Model {
  @exclusion(['blue']) color = 'red';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('color')
        .exclusion(['blue']);
  }
}

Format

Ensure it matches a regex

export class Model {
  @format(/\d{5}(-\d{4})?/) zipCode = '90210';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('zipCode')
        .format(/\d{5}(-\d{4})?/);
  }
}

Inclusion

Ensure it is included a set of values

export class Model {
  @inclusion(['blue', 'red']) blueOrRed = 'yellow';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('blueOrRed')
        .format(['blue', 'red']);
  }
}

Length

Ensure it is a certain length

export class Model {
  @length({ minimum: 5, maximum: 25 }) password = 'equal';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('password')
        .length({ minimum: 5, maximum: 25 });
  }
}

Numericality

Ensure it is a number (additional validation available, check validate.js documentation for more options)

export class Model {
  @numericality({ onlyInteger: true, lessThan: 115, greaterThan: 0 }) age = 25;
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('age')
        .length({ onlyInteger: true, lessThan: 115, greaterThan: 0 });
  }
}

Presence / Required

Ensure it is set

export class Model {
  @presence lastName = 'Skywalker';
  @required lastName = 'Skywalker';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('firstName')
        .required();
  }
}

URL

Ensure it is a valid URL

export class Model {
  @url website = 'http://www.google.com';
}
 
export class Model {
  constructor() {
    this.validator = new Validator(this)
      .ensure('website')
        .url();
  }
}

Building The Code

To build the code, follow these steps.

  1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
  2. From the project folder, execute the following command:
npm install
  1. Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
  1. To build the code, you can now run:
gulp build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

  2. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

  1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
  1. Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
  1. Install the client-side dependencies with jspm:
jspm install
  1. You can now run the tests with this command:
karma start

Running the Sample App

There is a sample application provided that runs using the plugin itself. To run this application -

  1. Change to the sample directory
cd sample
  1. Install all of the sample application's dev dependencies:
npm install
  1. Install all of the sample application's client-side dependencies with jspm:
jspm install
  1. Do an initial build of the sample app files:
gulp build-sample
  1. You can now run sample application:
gulp watch

It will watch for changes to both src and sample/src and reload the browser on change.

Package Sidebar

Install

npm i aurelia-validatejs

Homepage

aurelia.io

Weekly Downloads

171

Version

0.7.0

License

MIT

Last publish

Collaborators

  • aureliaeffect
  • pwkad