@summit-electric-supply/ember-validators

2.1.2 • Public • Published

Ember Validators

build npm

A collection of EmberJS validators, forked from ember-validators.

Compatibility

  • Ember.js v3.16 or above
  • Ember CLI v2.13 or above
  • Node.js v10 or above

Installation

ember install @summit-electric-supply/ember-validators

Looking for help?

If it is a bug please open an issue on GitHub.

Usage

Validators can be individually imported and used as such

import validatePresence from '@summit-electric-supply/ember-validators/presence';
import validateLength from '@summit-electric-supply/ember-validators/length';

validatePresence('foo', { presence: true });
validateLength('foo', { min: 1 });

or via the validate method provided

import { validate } from '@summit-electric-supply/ember-validators';

validate('presence', 'foo', { presence: true });
validate('length', 'foo', { min: 1 });

Validator Method Signature

Each validator has the following signature:

function (value, options, model, attribute) {}

Parameters:

  • value (Mixed):

    The value to validate

  • options (Object):

    A mutable object that holds validation specific options

  • model (Object):

    The model that is being validated

  • attribute (String):

    The attribute that is being validated

Returns:

  • Boolean

    true will be returned if the validation passed

  • Object

    Validation failed and a message should be built with the given attributes

    • type (String):

      The message type

    • value (Mixed):

      The value that was validated

    • context (Object):

      The error message context

    • message (String):

      The error message. If this is specified, use this string as the error message instead of building one.

Package Sidebar

Install

npm i @summit-electric-supply/ember-validators

Weekly Downloads

5

Version

2.1.2

License

MIT

Unpacked Size

48.8 kB

Total Files

27

Last publish

Collaborators

  • seswwylie
  • shernandez1977
  • ahristian