Module decorators/IsByteLength

Index

Functions

Functions

IsByteLength

IsByteLength(min: number, max?: number, validationOptions?: ValidationOptions): (object: any, propertyName: string) => void

- Defined in decorators/IsByteLength.ts:22
Decorator that checks if the string byte length is in range.
Example
```
class IsByteLengthDemo {
      @IsByteLength(0, 4) 
      alpha:string= 'abc'
}
```
Parameters
- min: number
- Optional max: number
- 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/IsByteLength.ts:73
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/IsByteLength.ts:61
Value is valid if it passes the {@link isByteLength} 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 isByteLength}

Generated using TypeDoc