This document maintains a list of changes to the superstruct package with each new version. Until 1.0.0 is released, breaking changes will be added as minor version bumps, and smaller changes and fixes won't be detailed.
-
Validators must now return
true,falseor an error reason string. Previously any truthy value would be considered valid. Now you can provide more information for the thrown errors by providing a string which will be attached aserror.reason. However, this means that truthy string values now equate to invalid, not valid. -
Property validators now receive
dataas their second argument. Previously you only had access to the propertyvalue, but now you also have access to the entire object'sdata.
- Errors can now contain reason information. Validator functions can now return string instead of a boolean, denoting the reason a value was invalid. This can then be used to create more helpful error messages.
-
objectstructs are no longer optional-ish. Previously object struct types would not throw ifundefinedwas passed and no properties were required. This was not only confusing, but complex to maintain. Now if you want an object struct to be optional, use thestruct.optional(...)helper. -
Removed the
Struct.defaultmethod. If you need to get the default value, use theStruct.validateorStruct.assertmethods's return value instead.
- Added the
dict,enum,intersection,unionandtuplestructs. These are all available asstruct.dict,struct.enum, etc.
-
The
validate()method now returns[ error, result ]. Previously it only had a single return value, which necessitated extra type checking to see if the value was an error or a result. Now you can just destructure the array to get either return value, for easier coding. -
Errors have been simplified, removing "codes". Previously there were multiple types of errors that were thrown and you could differentiate between them with the
error.codeproperty. But the other properties of the error already let you infer the code, so having multiple types of errors made for a larger API surface without much benefit.
- Structs are now functions again. 😄 They are built on the same underlying schema classes underneath though, since that helps the code structure. But to allow for the
struct = Struct({ ... })syntax the structs themselves have changed to be function.
- The basic case is now
Struct(data). Previously you had to useStruct.assert(data). Although theassertmethod (and others) are still there, the basic case is a bit terser and more similar to the struct-initializing APIs in other languages.
- Structs are now classes instead of functions. This is better in terms of the API being a bit less magic-y. It's also useful so that we can add other helpful methods to structs besides the
assertmethod. What was previouslystruct(data)is nowstruct.assert(data).
🎉