https://github.com/sebastian-software/vuex-validator

[UNMAINTAINED] Validator library for Vuex
https://github.com/sebastian-software/vuex-validator

Last synced: about 2 months ago
JSON representation

[UNMAINTAINED] Validator library for Vuex

• Host: GitHub
• URL: https://github.com/sebastian-software/vuex-validator
• Owner: sebastian-software
• License: apache-2.0
• Archived: true
• Created: 2016-05-11T14:32:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-29T11:49:15.000Z (about 7 years ago)
• Last Synced: 2024-07-17T10:59:28.607Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 66.4 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-vue-cn - Vuex Validator - Validator library for simple and complex state validation by @sebastiansoft ^{1.0 compatible} (Awesome Vue.js [](https://github.com/sindresorhus/awesome) / Libraries & Plugins)

README

        
[unmaintained-url]: .github/ISSUE_TEMPLATE.md

[unmaintained-image]: https://img.shields.io/badge/project-unmaintained-red.svg



# Vuex Validator
[![Project unmaintained][unmaintained-image]][unmaintained-url] [![Sponsored by][sponsor-img]][sponsor] [![Version][npm-version-img]][npm] [![Downloads][npm-downloads-img]][npm] [![Build Status][ci-img]][ci] [![Dependencies][deps-img]][deps]

[Vuex] Plugin for validation of store values.

[sponsor-img]: https://img.shields.io/badge/Sponsored%20by-Sebastian%20Software-692446.svg

[sponsor]: https://www.sebastian-software.de

[Vuex]: https://github.com/vuejs/vuex

[ci-img]:  https://travis-ci.org/sebastian-software/vuex-validator.svg

[ci]:      https://travis-ci.org/sebastian-software/vuex-validator

[deps]: https://david-dm.org/sebastian-software/vuex-validator

[deps-img]: https://david-dm.org/sebastian-software/vuex-validator.svg

[npm]: https://www.npmjs.com/package/vuex-validator

[npm-downloads-img]: https://img.shields.io/npm/dm/vuex-validator.svg

[npm-version-img]: https://img.shields.io/npm/v/vuex-validator.svg

## Links

- [GitHub](https://github.com/sebastian-software/vuex-validator)

- [NPM](https://www.npmjs.com/package/vuex-validator)

## Installation

Should be installed locally in your project source code:

Installation via JSPM:

```bash

jspm install npm:vuex-validator

```

Alternatively you can also use plain old NPM:

```bash

npm install vuex-validator --save

```

## Integration

In your main application javascript file:

````

// app.js

import { VuexValidator } from "vuex-validator";

import validators from "./vuex/validators";

import store from "./vuex/store"; // Inside there should be a Vue.use(Vuex) (see Vuex documentation)

Vue.use(VuexValidator, {

  validators

})

````

Your validator configurator:

````

// ./vuex/validators

import testValidator from "./validation/test";

const validators = [ testValidator ];

export default validators;

````

A sample validator:

````

// ./vuex/validation/test.js

import { BaseValidator } from "vuex-validator/lib/BaseValidator";

class TestValidator extends BaseValidator {

	constructor() {

		super("test"); // Name of validation are, should correlate with Vuex store module

		this.rule("test-name", ["test", "test2"], this.testName); // Name of rule, All properties that are tested, Test function itself

	}

	testName(state) { // State from Vuex

		if (typeof(state.test) !== "number") {

			this.invalid(["test"], "TEST_NOT_A_NUMBER"); // Failed properties and technical error key as string

		}

		if (typeof(state.test2) !== "string") {

			this.invalid(["test2"], "TEST2_NOT_A_STRING"); // Failed properties and technical error key as string

		}

		if (state.test > 20 && state.test2 === "low number") {

			this.invalid(["test", test2"], "TEST_IS_NO_LOW_NUMBER"); // Failed properties and technical error key as string

		}

		return this.errors(); // Return null if no errors, otherwise array of errors

	}

}

export default new TestValidator();

````

A sample state for this could be:

````

{

	"test": 123,

	"test2": "a string"

}

````

## Usage

There are two ways to use this validation.

### Active validation

To actively validate values you can call

````

store.$validator.isValid("test-name")

````

This validates all values of Validator named *test-name*. It returnes `true` if all values are valid as defined by your rules in validator *test-name*. This could be used for backend

connection middleware before sending data.

### Validation getter in components

Validation getters are added to a component's option object with key `validators`. This bears

analogy to Vuex getters itself mapping global state to component's local state.

````

export default Vue.extend({

	...

	validators: {

		testInvalid: (validator) => validator.isInvalid("test"),

		test2Invalid: (validator) => validator.isInvalid("test2")

	}

});

````

isInvalid takes a property path as string. This is either the property name itself or module name and property name seperated via dot.

````

""

"."

````

All validator functions are mapped to the component's local computed getters. So it is possible to access validation properties in template:

````

My property {{test}} is invalid: {{testInvalid}}

````

A falsy value (`undefined`, `null` or `false`) is returend in case of the property validated through all rules. Otherwise an array of failing rules return values are returned. the return structure can be something like:

````

[{

	error: "TEST_IS_NO_LOW_NUMBER",

	fields: ["test", "test2"],

	valid: false

}]

````

`fields` is an array of properties that are tested against in the failing rule. `error`

is the technical error key defined.

## Copyright



Copyright 2015-2016
[Sebastian Software GmbH](http://www.sebastian-software.de)