Module decorators/IsDivisibleBy

Index

Functions

Functions

IsDivisibleBy

IsDivisibleBy(target: number, validationOptions?: ValidationOptions): (object: any, propertyName: string) => void

- Defined in decorators/IsDivisibleBy.ts:21
Decorator that checks if the property is divisible by the argument.
Example
```
class IsDivisibleByDemo {
      @IsDivisibleBy(2) 
      d:number = 10
}
```
Parameters
- target: number
  
  The number that the value should be divisible by.
- 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/IsDivisibleBy.ts:65
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/IsDivisibleBy.ts:55
Value is valid if it passes the {@link isDivisibleBy} 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 isDivisibleBy}

Generated using TypeDoc