Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leny/dyagram

Micro validation schema for javascript structures
https://github.com/leny/dyagram

Last synced: 7 days ago
JSON representation

Micro validation schema for javascript structures

Host: GitHub
URL: https://github.com/leny/dyagram
Owner: leny
Created: 2016-01-30T17:29:27.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2016-02-08T09:21:53.000Z (almost 9 years ago)
Last Synced: 2024-04-11T15:58:56.811Z (7 months ago)
Size: 1000 Bytes
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# dyagram

> Micro validation schema for javascript structures

* * *

**dyagram** is a simple validation schema for javascript objects, made to be easy to learn and use.

## dyagram schema

A **dyagram** schema is a simple `json object`, representing the structure to validate.

### Check the presence/absence of a property

Give a `boolean` value to a property in schema to check for its presence (or absence) in structure, regardless of its type nor value.

#### Example

```javascript
{
"lastname": true, // will check for the presence of the lastname property
"age": false // will check for the absence of the age property
}
```

### Check the type of a property

Give a `string` value to a property in schema to check its type, regardless of its value.

#### Supported type

The following types are supported: `boolean`, `string`, `number`, `array`, `object`.

#### Example

```javascript
{
"lastname": "string",
"firstname": "string",
"age": "number",
"address": "object",
"skills": "array"
}
```

### Nested object

**dyagram** schema support nesting.

#### Example

```javascript
{
"lastname": "string",
"firstname": "string",
"age": "number",
"address": {
"street": "string",
"number": "number",
"city": "string",
"location": {
"latitude": "number",
"longitude": "number"
}
}
}
```

### Check for value

You can have more control on a property by using an `array`: the _first_ value of the array define the type of the property, the following values are defined by the following rules.

#### `boolean`

The second value defines the value of the property.

##### Example

```javascript
{
"is_happy": [ "boolean", true ] // will check for the property is_happy to be a boolean with the "true" value
}
```

#### `string`

If the second value is a `string`, it defines the value of the property ; if its a RegExp, it defines a pattern that the property must pass.

##### Example

```javascript
{
"name": [ "string", "leny" ], // will check for the property name to be a string with the "leny" value
"zip_code": [ "string", /[a-zA-Z0-9]*/ ] // will check for the property zip_code to be a string with a value passing the given regexp
}
```

#### `number`

If the second value is a `number`, it define the value of the property ; if there's a third value, the two are used to define a valid range for the property's value.

##### Example

```javascript
{
"age": [ "number", 30 ], // will check for the property age to be a number with 30 as value
"screens": [ "number", 1, 3 ] // will check for the property screens to be a number with a value between 1 & 3
}
```

_TO BE CONTINUED_