Yup v1.0.0-beta.2 Release Notes

Release Date: 2022-01-21 // 8 months ago
  • ๐Ÿ› Bug Fixes

    ๐Ÿ”‹ Features

    ๐Ÿ’ฅ BREAKING CHANGES

    • The function version of when() has been changed to make it easier to type. values are always passed as an array and schema, and options always the second and third argument. this is no longer set to the schema instance. and all functions must return a schema to be type safe
     string()
    -   .when('other', function (other) => {
    -      if (other) return this.required()
    +   .when('other', ([other], schema) => {
    +     return other ? schema.required() : schema
      })
    
    • ๐Ÿ— concat works shallowly now. Previously concat functioned like a deep merge for object, which produced confusing behavior with incompatible concat'ed schema. Now concat for objects works similar to how it works for other types, the provided schema is applied on top of the existing schema, producing a new schema that is the same as calling each builder method in order

    • ๐Ÿ“„ docs: update readme

    • โšก๏ธ chore: update to readonly arrays and test string type narrowing

    • โœ… test: add boolean tests

    • ๐Ÿ“„ docs: more docs

    • feat: allow mixed schema to specify type check

    • mixed schema are no longer treated as the base class for other schema types. It hasn't been for a while, but we've done some nasty prototype slinging to make it behave like it was. Now typescript types should be 1 to 1 with the actual classes yup exposes.

    In general this should not affect anything unless you are extending (via addMethod or otherwise) mixed prototype.

    import {
    -  mixed,
    +  Schema,
    } from 'yup';
    
    - addMethod(mixed, 'method', impl)
    + addMethod(Schema, 'method', impl)
    
    • chore: prep work for toggling coercion

    • Publish v1.0.0-alpha.4

    • ๐Ÿ“„ chore: docs

    • ๐Ÿšš feat!: add json() method and remove default object/array coercion

    • 0๏ธโƒฃ object and array schema no longer parse JSON strings by default, nor do they return null for invalid casts.

    object().json().cast('{}')
    array().json().cast('[]')
    

    to mimic the previous behavior

    • feat: Make Array generic consistent with others
    • types only, ArraySchema initial generic is the array type not the type of the array element. array<T>() is still the inner type.

    • Publish v1.0.0-beta.0

    • ๐Ÿ“„ docs