ODCheckerTypeSwitchStructureOptions interface
under construction
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This interface has the options for ODCheckerTypeSwitchStructure!
Properties
optional all class ➜ api.ODCheckerStructure
A checker that will always run (replaces all other checkers)
optional allowedTypes array ➜ ("string"|"number"|"boolean"|"object"|"other"|"null"|"array")[]
A list of allowed types
optional array class ➜ api.ODCheckerStructure
A checker when the property is an array
optional boolean class ➜ api.ODCheckerBooleanStructure
A checker when the property is a boolean
inherited optional custom function ➜ (checker:api.ODChecker, value:api.ODValidJsonType, locationTrace:api.ODCheckerLocationTrace, locationId:api.ODId, locationDocs:null|string) => boolean
Add a custom checker function. Returns true when valid.
inherited optional docs string ➜ string
Set the url to the documentation of this variable.
optional null class ➜ api.ODCheckerStructure
A checker when the property is null
optional number class ➜ api.ODCheckerNumberStructure
A checker when the property is a number
optional object class ➜ api.ODCheckerObjectStructure
A checker when the property is an object
optional other class ➜ api.ODCheckerStructure
A checker when the property is something else
optional string class ➜ api.ODCheckerStringStructure
A checker when the property is a string