Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(*)!: add custom message options to all shapes, validators and co…
…nstraints (#231) BREAKING CHANGE: Most shapes and validators that were previously getters are now functions to allow for custom options. The following list should show all of the changes, but if we have forgot any and you get an error saying something should be a function where you have provided a constant it is safe to assume you simply need to add `()` to your code for it to work again. BREAKING CHANGE: `PickDefined` utility type has been removed. BREAKING CHANGE: `PickUndefinedMakeOptional` utility type has been removed. BREAKING CHANGE: `NonNullObject` utility type has been removed. BREAKING CHANGE: `s.any` is now `s.any()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthEqual` is now `s.array(T).lengthEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthGreaterThan` is now `s.array(T).lengthGreaterThan()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthGreaterThanOrEqual` is now `s.array(T).lengthGreaterThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthLessThan` is now `s.array(T).lengthLessThan()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthLessThanOrEqual` is now `s.array(T).lengthLessThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthNotEqual` is now `s.array(T).lengthNotEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthRange` is now `s.array(T).lengthRange()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthRangeExclusive` is now `s.array(T).lengthRangeExclusive()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).lengthRangeInclusive` is now `s.array(T).lengthRangeInclusive()` to allow for custom options as argument. BREAKING CHANGE: `s.array(T).unique` is now `s.array(T).unique()` to allow for custom options as argument. BREAKING CHANGE: `s.array` is now `s.array()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint.divisibleBy` is now `s.bigint().divisibleBy()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint.equal` is now `s.bigint().equal()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint.greaterThan` is now `s.bigint().greaterThan()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint.greaterThanOrEqual` is now `s.bigint().greaterThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint.lessThan` is now `s.bigint().lessThan()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint.lessThanOrEqual` is now `s.bigint().lessThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint.notEqual` is now `s.bigint().notEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.bigint().abs` is now `s.bigint().abs()` to allow for custom options as second argument. BREAKING CHANGE: `s.bigint().negative` is now `s.bigint().negative()` to allow for custom options as second argument. BREAKING CHANGE: `s.bigint().positive` is now `s.bigint().positive()` to allow for custom options as second argument. BREAKING CHANGE: `s.bigint` is now `s.bigint()` to allow for custom options as argument. BREAKING CHANGE: `s.bigInt64Array` is now `s.bigInt64Array()` to allow for custom options as argument. BREAKING CHANGE: `s.bigUint64Array` is now `s.bigUint64Array()` to allow for custom options as argument. BREAKING CHANGE: `s.boolean.false` is now `s.boolean().false()` to allow for custom options as second argument. BREAKING CHANGE: `s.boolean.true` is now `s.boolean().true()` to allow for custom options as second argument. BREAKING CHANGE: `s.boolean` is now `s.boolean()` to allow for custom options as argument. BREAKING CHANGE: `s.default(...)` now gets a second parameter to allow for custom options as argument. BREAKING CHANGE: `s.default(...).default(...)` now gets a second parameter to allow for custom options as argument. BREAKING CHANGE: `s.date.equal` is now `s.date().equal()` to allow for custom options as argument. BREAKING CHANGE: `s.date.greaterThan` is now `s.date().greaterThan()` to allow for custom options as argument. BREAKING CHANGE: `s.date.greaterThanOrEqual` is now `s.date().greaterThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.date.invalid` is now `s.date().invalid()` to allow for custom options as argument. BREAKING CHANGE: `s.date.lessThan` is now `s.date().lessThan()` to allow for custom options as argument. BREAKING CHANGE: `s.date.lessThanOrEqual` is now `s.date().lessThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.date.notEqual` is now `s.date().notEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.date.valid` is now `s.date().valid()` to allow for custom options as argument. BREAKING CHANGE: `s.date` is now `s.date()` to allow for custom options as argument. BREAKING CHANGE: `s.enum(1, 2, 3)` is now `s.enum([1, 2, 3])` to allow for custom options as second argument. BREAKING CHANGE: `s.float32Array` is now `s.float32Array()` to allow for custom options as argument. BREAKING CHANGE: `s.float64Array` is now `s.float64Array()` to allow for custom options as argument. BREAKING CHANGE: `s.int16Array` is now `s.int16Array()` to allow for custom options as argument. BREAKING CHANGE: `s.int32Array` is now `s.int32Array()` to allow for custom options as argument. BREAKING CHANGE: `s.int8Array` is now `s.int8Array()` to allow for custom options as argument. BREAKING CHANGE: `s.never` is now `s.never()` to allow for custom options as argument. BREAKING CHANGE: `s.null` is now `s.null()` to allow for custom options as argument. BREAKING CHANGE: `s.nullable` is now `s.nullable()` to allow for custom options as argument. BREAKING CHANGE: `s.nullish` is now `s.nullish()` to allow for custom options as argument. BREAKING CHANGE: `s.nullish` is now `s.nullish()` to allow for custom options as argument. BREAKING CHANGE: `s.number.abs` is now `s.number().abs()` to allow for custom options as argument. BREAKING CHANGE: `s.number.ceil` is now `s.number().ceil()` to allow for custom options as argument. BREAKING CHANGE: `s.number.divisibleBy` is now `s.number().divisibleBy()` to allow for custom options as argument. BREAKING CHANGE: `s.number.equal` is now `s.number().equal()` to allow for custom options as argument. BREAKING CHANGE: `s.number.finite` is now `s.number().finite()` to allow for custom options as argument. BREAKING CHANGE: `s.number.floor` is now `s.number().floor()` to allow for custom options as argument. BREAKING CHANGE: `s.number.fround` is now `s.number().fround()` to allow for custom options as argument. BREAKING CHANGE: `s.number.greaterThan` is now `s.number().greaterThan()` to allow for custom options as argument. BREAKING CHANGE: `s.number.greaterThanOrEqual` is now `s.number().greaterThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.number.int` is now `s.number().int()` to allow for custom options as argument. BREAKING CHANGE: `s.number.lessThan` is now `s.number().lessThan()` to allow for custom options as argument. BREAKING CHANGE: `s.number.lessThanOrEqual` is now `s.number().lessThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.number.negative` is now `s.number().negative()` to allow for custom options as argument. BREAKING CHANGE: `s.number.notEqual` is now `s.number().notEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.number.positive` is now `s.number().positive()` to allow for custom options as argument. BREAKING CHANGE: `s.number.round` is now `s.number().round()` to allow for custom options as argument. BREAKING CHANGE: `s.number.safeInt` is now `s.number().safeInt()` to allow for custom options as argument. BREAKING CHANGE: `s.number.sign` is now `s.number().sign()` to allow for custom options as argument. BREAKING CHANGE: `s.number.trunc` is now `s.number().trunc()` to allow for custom options as argument. BREAKING CHANGE: `s.number` is now `s.number()` to allow for custom options as argument. BREAKING CHANGE: `s.object.ignore` is now `s.object().ignore()` to allow for custom options as argument. BREAKING CHANGE: `s.object.partial` is now `s.object().partial()` to allow for custom options as argument. BREAKING CHANGE: `s.object.passthrough` is now `s.object().passthrough()` to allow for custom options as argument. BREAKING CHANGE: `s.object.required` is now `s.object().required()` to allow for custom options as argument. BREAKING CHANGE: `s.object.strict` is now `s.object().strict()` to allow for custom options as argument. BREAKING CHANGE: `s.optional` is now `s.optional()` to allow for custom options as argument. BREAKING CHANGE: `s.required(...)` now gets a second parameter to allow for custom options as argument. BREAKING CHANGE: `s.set` is now `s.set()` to allow for custom options as argument. BREAKING CHANGE: `s.string.date` is now `s.string().date()` to allow for custom options as argument. BREAKING CHANGE: `s.string.email` is now `s.string().email()` to allow for custom options as argument. BREAKING CHANGE: `s.string.ipv4` is now `s.string().ipv4()` to allow for custom options as argument. BREAKING CHANGE: `s.string.ipv6` is now `s.string().ipv6()` to allow for custom options as argument. BREAKING CHANGE: `s.string().ip` is now `s.string().ip()` to allow for custom options as argument. BREAKING CHANGE: `s.string().lengthEqual` is now `s.string().lengthEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.string().lengthGreaterThan` is now `s.string().lengthGreaterThan()` to allow for custom options as argument. BREAKING CHANGE: `s.string().lengthGreaterThanOrEqual` is now `s.string().lengthGreaterThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.string().lengthLessThan` is now `s.string().lengthLessThan()` to allow for custom options as argument. BREAKING CHANGE: `s.string().lengthLessThanOrEqual` is now `s.string().lengthLessThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.string().lengthNotEqual` is now `s.string().lengthNotEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.string().phone` is now `s.string().phone()` to allow for custom options as argument. BREAKING CHANGE: `s.string().regex` is now `s.string().regex()` to allow for custom options as argument. BREAKING CHANGE: `s.string().url` is now `s.string().url()` to allow for custom options as argument. BREAKING CHANGE: `s.string` is now `s.string()` to allow for custom options as argument. BREAKING CHANGE: `s.tuple(1, 2, 3)` is now `s.tuple([1, 2, 3])` to allow for custom options as second argument. BREAKING CHANGE: `s.typedArray(T).byteLengthEqual` is now `s.typedArray(T).byteLengthEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthGreaterThan` is now `s.typedArray(T).byteLengthGreaterThan()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthGreaterThanOrEqual` is now `s.typedArray(T).byteLengthGreaterThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthLessThan` is now `s.typedArray(T).byteLengthLessThan()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthLessThanOrEqual` is now `s.typedArray(T).byteLengthLessThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthNotEqual` is now `s.typedArray(T).byteLengthNotEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthRange` is now `s.typedArray(T).byteLengthRange()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthRangeExclusive` is now `s.typedArray(T).byteLengthRangeExclusive()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).byteLengthRangeInclusive` is now `s.typedArray(T).byteLengthRangeInclusive()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthEqual` is now `s.typedArray(T).lengthEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthGreaterThan` is now `s.typedArray(T).lengthGreaterThan()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthGreaterThanOrEqual` is now `s.typedArray(T).lengthGreaterThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthLessThan` is now `s.typedArray(T).lengthLessThan()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthLessThanOrEqual` is now `s.typedArray(T).lengthLessThanOrEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthNotEqual` is now `s.typedArray(T).lengthNotEqual()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthRange` is now `s.typedArray(T).lengthRange()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthRangeExclusive` is now `s.typedArray(T).lengthRangeExclusive()` to allow for custom options as argument. BREAKING CHANGE: `s.typedArray(T).lengthRangeInclusive` is now `s.typedArray(T).lengthRangeInclusive()` to allow for custom options as argument. BREAKING CHANGE: `s.uint16Array` is now `s.uint16Array()` to allow for custom options as argument. BREAKING CHANGE: `s.uint32Array` is now `s.uint32Array()` to allow for custom options as argument. BREAKING CHANGE: `s.uint8Array` is now `s.uint8Array()` to allow for custom options as argument. BREAKING CHANGE: `s.uint8ClampedArray` is now `s.uint8ClampedArray()` to allow for custom options as argument. BREAKING CHANGE: `s.undefined` is now `s.undefined()` to allow for custom options as argument. BREAKING CHANGE: `s.union(1, 2, 3).required` is now `s.union(1, 2, 3).required()` to allow for custom options as argument. BREAKING CHANGE: `s.union(1, 2, 3)` is now `s.union([1, 2, 3])` to allow for custom options as second argument. BREAKING CHANGE: `s.unknown` is now `s.unknown()` to allow for custom options as argument. BREAKING CHANGE: `uniqueArray` is now a function (instead of a constant) to allow for custom options as argument. BREAKING CHANGE: `dateInvalid` is now a function (instead of a constant) to allow for custom options as argument. BREAKING CHANGE: `dateValid` is now a function (instead of a constant) to allow for custom options as argument. BREAKING CHANGE: `numberFinite` is now a function (instead of a constant) to allow for custom options as argument. BREAKING CHANGE: `numberInt` is now a function (instead of a constant) to allow for custom options as argument. BREAKING CHANGE: `numberNaN` is now a function (instead of a constant) to allow for custom options as argument. BREAKING CHANGE: `numberNotNaN` is now a function (instead of a constant) to allow for custom options as argument. BREAKING CHANGE: `numberSafeInt` is now a function (instead of a constant) to allow for custom options as argument.
- Loading branch information
