Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@aibex/ayup

0.1.3 • Public • Published

ayup

a(ny)yup. Useful Yup helpers and functions. Synchronous and Async.

CircleCI Dependabot Status

Add via Yarn yarn add @aibex/ayup

or via npm npm install @aibex/ayup

ayup is designed to be a simple way to do hard things in yup. Yup's lightweight, asynchronous, and generally a better choice for simple validation. But some edges are rough. And if you're here, you're probably rubbing against one of those right now.

For every method, both synchronous and asynchronous support is available. By default, every plugin is ready to be added to yup via yup.addMethod. However, if polluting the global yup object isn't your thing, there's an augment method that favors yup's "template schema" approach. Examples are provided for both routes.

augment

Create a template object, containing non-global versions of one or more ayup plugins. Augment walks through the list of supplied plugins, associates them with the plugin's yup type, and returns an object literal containing your schema-ready yup objects.

import * as yup from "yup";
import { augment, oneOfSchema } from "@aibex/ayup";
 
const myTemplateSchemas = augment(oneOfSchema(yup), anotherSchema(yup));
 
const mySchema = yup.object().shape({
  myKey: myTemplateSchemas.oneOfSchema([
    /*schemas*/
  ]),
});

oneOfSchema

Passes validation if at least one schema in the array is valid.

import * as yup from "yup";
import { oneOfSchema } from "@aibex/ayup";
 
// globally add to yup
yup.addMethod(...oneOfSchema(yup));
yup.addMethod.apply(yup, oneOfSchema(yup)); // non-spread operator
 
const mySchema = yup.object().shape({
  myKey: yup.mixed().oneOfSchema([
    /*schemas*/
  ]),
});
import * as yup from "yup";
import { augment, oneOfSchema } from "@aibex/ayup";
 
const schemas = augment(oneOfSchema(yup));
 
const mySchema = yup.object().shape({
  myKey: schemas.oneOfSchema([
    /*schemas*/
  ]),
});

Tests

Test are written using ava. You can run the test suite using yarn test.

Releasing

While we use yarn for everything internally, release-it works more consistently with npm run-script release. This is because of how npm/yarn manage their logins.

Install

npm i @aibex/ayup

DownloadsWeekly Downloads

8

Version

0.1.3

License

none

Unpacked Size

24.2 kB

Total Files

13

Last publish

Collaborators

  • avatar