Module decorators/IsSurrogatePair

Index

Functions

Functions

IsSurrogatePair

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

- Defined in decorators/IsSurrogatePair.ts:21
Decorator that checks if the property contains surrogate pairs chars.
Example
```
class IsSurrogatePairDemo {
    @IsSurrogatePair()
    alpha:string = '𠮷野𠮷'
}
```
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/IsSurrogatePair.ts:60
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/IsSurrogatePair.ts:51
Value is valid if it passes the {@link isSurrogatePair} 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 isSurrogatePair}

Generated using TypeDoc