Failure objects represent a specific failure in validation. They are plain
objects that can be turned into real StructError when needed.
{
type: 'number',
value: 'invalid',
path: [1],
branch: [
[1, 'invalid', 2],
'invalid',
]
}Failures can also be augmented with any of your on custom properties.
The branch of values following a path down from the root.
The path of indices to retrieve the failing value from the root.
The expected type description of the failing value, or undefined if it
didn't have an expected type.
The failing value.
Path arrays specify a nested value's location in a root object or array.
['user', 'address', 'city']
['nodes', 1, 'nodes', 0, 'text']Validator functions allow developers to define their own scalar types for
Superstruct to validate against, and return an indication of what is invalid.
import { superstruct } from 'superstruct'
import isEmail from 'is-email'
const struct = superstruct({
types: {
email: value => isEmail(value) && value.length < 256,
}
})The singleton instance of Superstruct that is exported by default, configured with types for all of the JavaScript built-in data types. The singleton instance of Superstruct that is exported by default, configured with types for all of the JavaScript built-in data types.
You can use it if you don't need any custom types. However, if you do want to define custom types, use the superstruct factory to configure your own Superstruct instance.
You can use it if you don't need any custom types. However, if you do want to define custom types, use the superstruct factory to configure your own Superstruct instance.
Check if a value is a Struct object.
Create a struct singleton with settings that include your own domain-specific
data types, and an optional custom Error class.
Superstruct ships by default with an unopinionated set of scalar types that express all of the data types that are built-in to JavaScript.
Matches any value other than undefined.
'anything'
trueMatches an arguments object.
argumentsMatches an Array.
[1, 2, 3]Matches a boolean.
true
falseMatches a Node.js Buffer.
Buffer.from('string')Matches a valid Date object.
new Date()Note: Invalid Date objects that equal NaN are not matched.
Matches an error object.
new Error()Matches a Float32Array object.
Matches a Float64Array object.
Matches a function.
() => {}
function () {}Matches a generator function.
function* () {}Matches a Int16Array object.
Matches a Int32Array object.
Matches a Int8Array object.
Matches a Map object.
new Map()Matches the null literal value.
nullMatches a number.
42Matches a plain object.
{ key: 'value' }
{ something: true }Matches a Promise object.
Promise.resolve()Matches a regular expression object.
/a-z/gMatches a Set object.
new Set()Matches a string.
'text'Matches a Symbol.
Symbol()Matches a Uint16Array object.
Matches a Uint32Array object.
Matches a Uint8Array object.
Matches a Uint8ClampedArray object.
Matches the undefined literal value.
undefinedMatches a WeakMap object.
new WeakMap()Matches a WeakSet object.
new WeakSet()
Brancharrays contain each value following a path down from the root.