Class: NumberType
Defined in: schema/types/number-type.ts:39
Number
are plain JavaScript Number.
Options
- required flag to define if the field is mandatory
- validator that will be applied to the field a validation function, validation object or string with the name of the custom validator
- default that will define the initial value of the field, this option allows a value or a function
- immutable that will define this field as immutable. Ottoman prevents you from changing immutable fields if the schema as configure like strict
- intVal flag that will allow only integer values
- min minimum numerical value value that will be accepted
- max maximum numeric value that will be accepted
Example
const userSchema = new Schema({
age: Number,
})
Extends
Constructors
Constructor
new NumberType(
name
,options?
):NumberType
Defined in: schema/types/number-type.ts:40
Parameters
name
string
options?
CoreTypeOptions
& NumberTypeOptions
Returns
NumberType
Overrides
Properties
name
name:
string
Defined in: schema/interfaces/schema.types.ts:51
Inherited from
options?
optional
options:CoreTypeOptions
Defined in: schema/types/core-type.ts:23
Inherited from
typeName
typeName:
string
Defined in: schema/interfaces/schema.types.ts:51
Inherited from
sName
static
sName:string
=Number.name
Defined in: schema/types/number-type.ts:43
Overrides
Accessors
default
Get Signature
get default():
unknown
Defined in: schema/types/core-type.ts:39
Returns
unknown
Inherited from
intVal
Get Signature
get intVal():
boolean
Defined in: schema/types/number-type.ts:55
Returns
boolean
max
Get Signature
get max():
undefined
|number
|NumberFunction
|MinmaxOption
Defined in: schema/types/number-type.ts:45
Returns
undefined
| number
| NumberFunction
| MinmaxOption
min
Get Signature
get min():
undefined
|number
|NumberFunction
|MinmaxOption
Defined in: schema/types/number-type.ts:50
Returns
undefined
| number
| NumberFunction
| MinmaxOption
required
Get Signature
get required():
boolean
|RequiredOption
|RequiredFunction
Defined in: schema/types/core-type.ts:31
Returns
boolean
| RequiredOption
| RequiredFunction
Inherited from
validator
Get Signature
get validator():
undefined
|string
|ValidatorFunction
|ValidatorOption
Defined in: schema/types/core-type.ts:35
Returns
undefined
| string
| ValidatorFunction
| ValidatorOption
Inherited from
Methods
buildDefault()
buildDefault():
unknown
Defined in: schema/types/core-type.ts:43
Returns
unknown
Inherited from
cast()
cast(
value
,strategy
):unknown
Defined in: schema/types/number-type.ts:60
Parameters
value
unknown
strategy
CAST_STRATEGY
= CAST_STRATEGY.DEFAULT_OR_DROP
Returns
unknown
Overrides
checkRequired()
checkRequired():
string
|void
Defined in: schema/types/core-type.ts:62
Returns
string
| void
Inherited from
checkValidator()
checkValidator(
value
):void
Defined in: schema/types/core-type.ts:71
Parameters
value
unknown
Returns
void
Inherited from
isEmpty()
isEmpty(
value
):boolean
Defined in: schema/types/core-type.ts:75
Parameters
value
unknown
Returns
boolean
Inherited from
isStrictStrategy()
isStrictStrategy(
strategy
):boolean
Defined in: schema/types/core-type.ts:79
Parameters
strategy
Returns
boolean
Inherited from
validate()
validate(
value
,strategy
):unknown
Defined in: schema/types/number-type.ts:69
Parameters
value
unknown
strategy
any
Returns
unknown