stampper v1.2.1

TS decorators-based JSON validator.

Example

First, define the model.

class Person {
  @String({ minLength: 3})
  name: string;

  @Number({ optional: true })
  years: number;

  @List({ allowedValues: ['ES', 'EN', 'FR'], separator: ',' })
  languages: string;

  @Class({ class: Country })
  countriesVisited: Country[];
}

class Country {
  @String()
  name: string;

  @Class({ class: City })
  cities: City[];
}

class City {
  @String()
  name: string;
}

And, then, call validateJSON passing the model and the JSON value to be validated.

validateJSON(Person, {
  name: 'Name',
  years: 50,
  languages: 'ES,EN',
  countriesVisited: [
    {
      name: 'Spain',
      cities: [
        { name: 'Madrid' },
        { name: 'Valencia' },
      ]
    }
  ],
});

If an invalid JSON is provided, an error will be thrown. Example:

try {
  validateJSON(Person, {
    name: 'Name',
    years: 50,
    languages: 'ES,EN',
    countriesVisited: [
      {
        // name: 'Spain', <- This required property is removed
        cities: [
          { name: 'Madrid' },
          { name: 'Valencia' },
        ]
      }
    ],
  });
} catch (error) {
  console.error(error);
}

Will result in the following error printed out:

MissingRequiredPropertyJSONError {
  typeCode: 2,
  typeName: 'MissingRequiredProperty',
  name: 'name',
  value: undefined,
  path: [ 'countriesVisited', 'name' ],
  message: 'Missing required property'
}

Validators options

The list below contains the validators/decorators that are currently supported along with their options.