returning-errors.js

import { object, number, string, validate } from '@superstruct/core'

// Define a struct to validate with.
const User = object({
  id: number(),
  name: string(),
  email: string(),
})

// Define data to be validated.
const data = {
  id: 1,
  name: true,
  email: 'jane@example.com',
}

// Validate the data with the `validate` method. In this case the `name`
// property is invalid, so an error will be returned.
const [error, user] = validate(data, User)
// [
//   StructError: 'Expected a value of type "string" for `name` but received `false`.' {
//     type: 'string',
//     value: false,
//     path: ['name'],
//     branch: [{...}, false],
//     failures: [...],
//   },
//   undefined
// ]