npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2021 – Pkg Stats / Ryan Hefner

sequelize-validate-subfields-typed-validators

v2.0.0

Published

sequelize-validate-subfields adapter for typed-validators

Downloads

216

Readme

sequelize-validate-subfields-typed-validators

CircleCI Coverage Status semantic-release Commitizen friendly npm version

use typed-validators to validate JSON attributes of Sequelize models

Installation

npm install --save typed-validators sequelize-validate-subfields-typed-validators

Example

import Sequelize from 'sequelize'
import * as t from 'typed-validators'
import { validateWithTypedValidators } from 'sequelize-validate-subfields-typed-validators'
import { flattenValidationErrors } from 'sequelize-validate-subfields'

import sequelize from './sequelize'

const UserInfoType = t.alias(
  'User',
  t.object({
    phone: t.string(),
    address: t.object({
      required: {
        line1: t.string(),
        postalCode: t.number(),
        state: t.string(),
      },
      optional: {
        line2: t.string(),
      },
    }),
  })
)

const User = Sequelize.define('User', {
  username: {
    type: Sequelize.STRING,
    validate: {
      notEmpty: {
        msg: 'required',
      },
    },
  },
  info: {
    type: Sequelize.JSON,
    validate: validateWithTypedValidators(UserInfoType),
  },
})

try {
  User.create({
    username: '',
    address: {
      line2: 2,
      postalCode: '76034',
      state: 'TX',
    },
  })
} catch (error) {
  if (error instanceof Sequelize.ValidationError) {
    console.error(flattenValidationErrors(error))
  } else {
    console.error(error)
  }
}

Output:

[
  {path: ['username'], message: 'required'},
  {path: ['address', 'line1'], message: 'must be a string'},
  {path: ['address', 'line2'], message: 'must be a string'},
  {path: ['address', 'postalCode'], message: 'must be a number'},
]

API

convertValidationErrors(validation, [options])

Arguments

validation: Validation

A typed-validators Validation object containing an errors array of [path, message, type] tuples.

options?: {reduxFormStyle?: boolean}

If reduxFormStyle is true, validation errors on object/array fields will be yielded for the _error subpath under that field.

Returns: Iterable<FieldValidation>

Yields {path: Array<string | number>, message: string} objects about validation errors, the format defined by sequelize-validate-subfields.

validateWithTypedValidators(typeOrValidator, [options])

Arguments

`typeOrValidator: Type | ((value: any) => ?Validation)

A typed-validators Type, or a function taking an attribute value and returning a typed-validators Validation object or null. Errors from applying the given function or validating against the given type will be yielded in sequelize-validate-subfields format.

options?: {reduxFormStyle?: boolean}

If reduxFormStyle is true, validation errors on object/array fields will be yielded for the _error subpath under that field.

Returns: (value: any) => void

A Sequelize custom attribute validation function that uses the given typeOrValidator to validate attribute values.