struct factory.anyany structs accept any value as valid.🤖 Note that if you're using TypeScript, theanystruct will loosen the type toany, and you might want to useunknowninstead.
arrayarray structs accept a list of values of a specific type.bigintbigint structs validate that a value is a bigint.booleanboolean structs accept the boolean values true and false.datedate structs accept JavaScript Date instances.🤖 To avoid unexpected runtime errors,datestructs do not accept invalidDateobjects, even though they are technically an instance of aDate. This meshes with the 99% use case where invalid dates create inconsistencies.
enumsenums structs validate that a value is one of a specific set of literals values.funcfunc structs validate that a value is a function.instanceinstance structs validate that a value is an instance of a particular class, using JavaScript's built-in instanceof operator.integerinteger structs validate that a value is an integer.intersectionintersection structs validate that a value matches all of many structs. It takes existing struct objects as arguments.literalliteral structs enforce that a value matches an exact value using the === operator.mapmap structs validate that a value is a Map object with specific types for its keys and values.🤖 When defining a key/value schemas withmapit will traverse all the properties to ensure they are valid! If you don't care about validating the properties of the map, you can writemap()instead.
nevernever structs will fail validation for every value.numbernumber structs validate that a value is a number.nullablenullable structs validate that a value matches a specific struct, or that it is null.objectobject structs validate that a value is an object and that each of its properties match a specific type as well.optionaloptional structs validate that a value matches a specific struct, or that it is undefined.🤖 Warning: If you are using TypeScript, you must enable TypeScript'sstrictNullChecksoption in yourtsconfig.jsonfor Superstruct to work properly with "optional" types. Note thatstrictNullChecksis disabled by default. If you enablestrict,strictNullCheckswill automatically be enabled.
recordrecord structs validate an object with specific types for its keys and values. But, unlike object structs, they do not enforce a specific set of keys.regexpregexp structs validate that a value is a RegExp object.🤖 This does not test the value against the regular expression! For that you want thepatternrefinement.
setset structs validate that a value is a Set instance with elements of a specific type.🤖 When defining a child schema withsetit will traverse all the children to ensure they are valid! If you don't care about validating the elements of the set, you can writeset()instead.
stringstring structs validate that a value is a string.tupletuple structs validate that a value is an array of a specific length with values each of a specific type.typetype structs validate that a value has a set of properties on it, but it does not assert anything about unspecified properties. This allows you to assert that a particular set of functionality exists without a strict equality check for properties.mask() is used with a value of type, its unknown properties are not removed. I.e. consider type as a signal to the core that the object may have arbitrary properties in addition to the known ones, in both masked and non-masked validation.unionunion structs validate that a value matches at least one of many types.unknownunknown structs accept unknown value as valid without loosening its type to any.true/false or an array of StructFailure objects, in case you want to build more helpful error messages.🤖 If you are using Typescript the value will be of typeunknownby default. You can pass a more specific type for Typescript:const Email = define<string>('Email', isEmail)