schemodo v1.1.5

schemodo

A library for validating and processing data structures with a focus on versatility, immutability and support for async/await. Inspired by validate and mongoose - but altogether a little different.

Full documentation is a work in progress.

New in 1.1.1

• NaN is now correctly considered a null-like value
• Custom typecast functions get passed the default typecaster as a third argument - making it easier to add to existing functionality.
• Added more documentation

Installation

Install with npm:

npm i schemodo --save

Then use it in your project:

const sm = require('schemodo');

Test

npm run test

Create a Schema

First, define a Schema:

const schema = new sm.Schema({
    name: String,
    age: {
        type: Number,
        size: { max: 100, },
    },
    options: {
        darkMode: Boolean,
        showImages: {
            type: Boolean,
            $default: true,
        }
    },
});

Then, validate or normalize a data structure:

// Validate:
const result = schema.validate( input );

if( result.ok() ){ 
    console.log( result.value );
}
else {
    const numErrors = result.errors.length;
    console.log( `Error count: ${numErrors}` );
}

// Normalize:
try {
    const output = schema.normalize( input );
    console.log( output );
} 
catch( err ){

    const result = err.result,
          numErrors = result.errors.length;
    
    console.log( `Error count: ${numErrors}` );

}

If no errors are encountered, the output matches the schema format and some values have been typecast:

const input = {
    name: 'Matt',
    age: '40',
    options: {
        darkMode: 'false',
    },
};

const output = schema.normalize( input );

// output:
{
    name: 'Matt',
    age: 40,
    options: {
        darkMode: false,
        showImages: true,
    },
}

Register a Model

A model is a named schema that you register on the main schemodo object:

const sm = require('schemodo');
const myschema = new sm.Schema({ /* ... */ });

sm.model( 'myschema', myschema );

After which you can reference it using:

const myschema = sm.model('myschema');

or:

const myschema = sm('myschema');

Changelog

New in 1.1.0

New keywords and associated unit tests for Array and Set; offering more built-in methods for string conversion: list, split, trim and trimEntries.