Module decorators/IsMongoID

Index

Functions

Functions

IsMongoID

IsMongoID(validationOptions?: ValidationOptions): (object: any, propertyName: string) => void

- Defined in decorators/IsMongoID.ts:21
Decorator that checks if the property is a MongoID.
Example
```
class IsMongoIDDemo {
    @IsMongoID('en-US') 
    @IsMongoID() 
    id:string = '507f1f77bcf86cd799439011'
}
```
Parameters
- 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/IsMongoID.ts:61
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/IsMongoID.ts:51
Value is valid if it passes the {@link isMongoId} 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 isMongoId}

Generated using TypeDoc