chore: add jsdoc to the isenum validator

algoan · Dec 11, 2023 · d084e4b · d084e4b
1 parent ea8e090
commit d084e4b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/class-validators/src/is-enum.decorator.ts b/packages/class-validators/src/is-enum.decorator.ts
@@ -1,5 +1,11 @@
 import { IsEnum as OriginalIsEnum, ValidationOptions } from 'class-validator';
 
+/**
+ * Checks if a given value is the member of the provided enum.
+ *
+ * This an override for the class-validator IsEnum validator.
+ * The error message is enhanced with the invalid value
+ */
 export const IsEnum = (entity: object, validationOptions?: ValidationOptions): PropertyDecorator =>
   OriginalIsEnum(entity, {
     message: '$property has the value $value but must be one of the following values: $constraint2',