Module decorators/IsNumber

Index

Functions

Functions

IsNumber

IsNumber(options?: IsNumberOptions, validationOptions?: ValidationOptions): (object: any, propertyName: string) => void

- Defined in decorators/IsNumber.ts:21
Decorator that checks if the property is a Number.
Example
```
class IsNumberDemo {
    @IsNumber() 
    alpha:number = 2 
}
```
Parameters
- options: IsNumberOptions = {}
- Optional validationOptions: ValidationOptions
  
  The validation options
Returns (object: any, propertyName: string) => void
- - (object: any, propertyName: string): void
  - Parameters
    - object: any
    - propertyName: string
    Returns void

validateArray

validateArray(vc: ValidationContext, values: any[]): Number[]

- Defined in decorators/IsNumber.ts:62
Parameters
- vc: ValidationContext
  
  The validation context.
- values: any[]
  
  The array of values.
Returns Number[]
An empty array if valid, an array of indexes otherwise.

validateValue

validateValue(vc: ValidationContext, o: any): boolean

- Defined in decorators/IsNumber.ts:53
Value is valid if it passes the {@link isNumber} check.

Parameters
- vc: ValidationContext
  
  The validation context.
- o: any
  
  The object containing the property to validate.
Returns boolean
The result of the call to {@link isNumber}

Generated using TypeDoc