Returns a new type that is the result of adding the rules of one type to another.
Sets a default value if the original value is undefined.
the value. value supports references. value may also be a function which returns the default value. If value is specified as a function that accepts a single parameter, that parameter will be a context object that can be used to derive the resulting value. This clones the object however, which incurs some overhead so if you don't need access to the context define your method so that it does not accept any parameters. Without any value, default has no effect, except for object that will then create nested defaults (applying inner defaults of that object).
Note that if value is an object, any changes to the object after default() is called will change the reference and any future assignment.
Additionally, when specifying a method you must either have a description property on your method or the second parameter is required.
Returns a plain object representing the schema's rules and properties
Annotates the key
Considers anything that matches the schema to be empty (undefined).
any object or joi schema to match. An undefined schema unsets that rule.
Overrides the default joi error with a custom error if the rule fails where:
can be:
an instance of Error - the override error.
a function(errors), taking an array of errors as argument, where it must either:
return a string - substitutes the error message with this text
return a single object or an Array of it, where:
type - optional parameter providing the type of the error (eg. number.min).
message - optional parameter if template is provided, containing the text of the error.
template - optional parameter if message is provided, containing a template string, using the same format as usual joi language errors.
context - optional parameter, to provide context to your error if you are using the template.
return an Error - same as when you directly provide an Error, but you can customize the error message based on the errors.
Note that if you provide an Error, it will be returned as-is, unmodified and undecorated with any of the
normal joi error properties. If validation fails and another error is found before the error
override, that error will be returned and the override will be ignored (unless the abortEarly
option has been set to false).
Annotates the key with an example value, must be valid.
Marks a key as forbidden which will not allow any value except undefined. Used to explicitly forbid keys.
Blacklists a value
Overrides the key name in error messages.
Attaches metadata to the key.
Annotates the key
Marks a key as optional which will allow undefined as values. Used to annotate the schema for readability as all keys are optional by default.
Overrides the global validate() options for the current key and any sub-key.
Outputs the original untouched value instead of the casted value.
Marks a key as required which will not allow undefined as value. All keys are optional by default.
Sets the options.convert options to false which prevent type casting for the current key and any child keys.
Marks a key to be removed from a resulting object or array after validation. Used to sanitize output.
Annotates the key
Annotates the key with an unit name.
Adds the provided values into the allowed whitelist and marks them as the only valid values allowed.
Validates a value using the schema and options.
Converts the type into an alternatives type where the conditions are merged into the type definition where:
Generated using TypeDoc
Whitelists a value