ODCheckerNumberStructureOptions interface
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 ODCheckerNumberStructure!
Properties
optional choices array ➜ number[]
You need to choose between ...
optional contains string ➜ string
This number needs to contain ...
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 endsWith string ➜ string
This number needs to end with ...
optional floatAllowed boolean ➜ boolean
Are numbers with a decimal value allowed?
optional is number ➜ number
This number is required to match the value
optional length number ➜ number
Set the required length of this number
optional max number ➜ number
The maximum value of this number
optional maxLength number ➜ number
The maximum length of this number
optional min number ➜ number
The minimum value of this number
optional minLength number ➜ number
The minimum length of this number
optional negativeAllowed boolean ➜ boolean
Are negative numbers allowed (without zero)
optional offset number ➜ number
The offset for the step function.
optional positiveAllowed boolean ➜ boolean
Are positive numers allowed (without zero)
optional startsWith string ➜ string
This number needs to start with ...
optional step number ➜ number
Only allow a multiple of ... starting at this.offset or 0
optional zeroAllowed boolean ➜ boolean
Is zero allowed?