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 🙏

© 2024 – Pkg Stats / Ryan Hefner

@zaalbarxx/vee-validate-yup

v4.12.7

Published

vee-validate integration with yup schema validation

Downloads

3

Readme

@zaalbarxx/vee-validate-yup

Official vee-validate integration with Yup schema validation

Getting started

You can use yup as a typed schema with the @zaalbarxx/vee-validate-yup package:

# npm
npm install @zaalbarxx/vee-validate-yup
# yarn
yarn add @zaalbarxx/vee-validate-yup
# pnpm
pnpm add @zaalbarxx/vee-validate-yup

The @vee-valdiate/yup package exposes a toTypedSchema function that accepts any yup schema. Which then you can pass along to validationSchema option on useForm.

This makes the form values and submitted values typed automatically and caters for both input and output types of that schema.

import { useForm } from '@zaalbarxx/vee-validate';
import { object, string } from 'yup';
import { toTypedSchema } from '@zaalbarxx/vee-validate-yup';

const { values, handleSubmit } = useForm({
  validationSchema: toTypedSchema(
    object({
      email: string().required(),
      password: string().required(),
      name: string(),
    })
  ),
});

// ❌ Type error, which means `values` is type-safe
values.email.endsWith('@gmail.com');

handleSubmit(submitted => {
  // No errors, because email is required!
  submitted.email.endsWith('@gmail.com');

  // ❌ Type error, because `name` is not required so it could be undefined
  // Means that your fields are now type safe!
  submitted.name.length;
});

Yup default values

You can also define default values on your schema directly and it will be picked up by the form:

import { useForm } from '@zaalbarxx/vee-validate';
import { object, string } from 'yup';
import { toTypedSchema } from '@zaalbarxx/vee-validate-yup';

const { values, handleSubmit } = useForm({
  validationSchema: toTypedSchema(
    object({
      email: string().required().default('[email protected]'),
      password: string().required().default(''),
      name: string().default(''),
    })
  ),
});

Your initial values will be using the schema defaults, and also the defaults will be used if the values submitted is missing these fields.

Yup transforms

You can also define transforms to cast your fields before submission:

import { useForm } from '@zaalbarxx/vee-validate';
import { object, number } from 'yup';
import { toTypedSchema } from '@zaalbarxx/vee-validate-yup';

const { values, handleSubmit } = useForm({
  validationSchema: toTypedSchema(
    object({
      age: number()
        .transform(val => Number(val))
        .required(),
    })
  ),
});

But note that this does not change the input or output types of the casted fields. The cast will only occur when setting the initial value and when the values are submitted.