feat: add missing validators

express-validator · Feb 15, 2023 · 5dc6622 · 5dc6622
1 parent 788c489
commit 5dc6622
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 5 deletions.
diff --git a/declarations/validator.d.ts b/declarations/validator.d.ts
@@ -98,7 +98,7 @@ declare module 'validator' {
   ): boolean;
   export function isLocale(str: string): boolean;
   export function isLowercase(str: string): boolean;
-  export function isLuhnValid(str: string): boolean;
+  export function isLuhnNumber(str: string): boolean;
   export function isMagnetURI(str: string): boolean;
   export function isMACAddress(
     str: string,
@@ -139,6 +139,7 @@ declare module 'validator' {
   ): boolean;
   export function isSurrogatePair(str: string): boolean;
   export function isTaxID(str: string, locale: import('../src/options').TaxIDLocale): boolean;
+  export function isTime(str: string, options?: import('../src/options').IsTimeOptions): boolean;
   export function isURL(str: string, options?: import('../src/options').IsURLOptions): boolean;
   export function isUUID(str: string, version?: import('../src/options').UUIDVersion): boolean;
   export function isUppercase(str: string): boolean;

diff --git a/src/chain/sanitizers-impl.spec.ts b/src/chain/sanitizers-impl.spec.ts
@@ -17,7 +17,7 @@ beforeEach(() => {
   sanitizers = new SanitizersImpl(builder, chain);
 });
 
-it('has methods for all standard validators', () => {
+it('has methods for all standard sanitizers', () => {
   // Cast is here to workaround the lack of index signature
   const validatorModule = validator as any;
 

diff --git a/src/chain/validators-impl.ts b/src/chain/validators-impl.ts
@@ -261,8 +261,8 @@ export class ValidatorsImpl<Chain> implements Validators<Chain> {
   isLowercase() {
     return this.addStandardValidation(validator.isLowercase);
   }
-  isLuhnValid() {
-    return this.addStandardValidation(validator.isLuhnValid);
+  isLuhnNumber() {
+    return this.addStandardValidation(validator.isLuhnNumber);
   }
   isMagnetURI() {
     return this.addStandardValidation(validator.isMagnetURI);
@@ -324,6 +324,9 @@ export class ValidatorsImpl<Chain> implements Validators<Chain> {
   isTaxID(locale: Options.TaxIDLocale) {
     return this.addStandardValidation(validator.isTaxID, locale);
   }
+  isTime(options?: Options.IsTimeOptions) {
+    return this.addStandardValidation(validator.isTime, options);
+  }
   isURL(options?: Options.IsURLOptions) {
     return this.addStandardValidation(validator.isURL, options);
   }

diff --git a/src/chain/validators.ts b/src/chain/validators.ts
@@ -138,7 +138,7 @@ export interface Validators<Return> {
   isLicensePlate(locale: Options.IsLicensePlateLocale): Return;
   isLocale(): Return;
   isLowercase(): Return;
-  isLuhnValid(): Return;
+  isLuhnNumber(): Return;
   isMagnetURI(): Return;
   isMACAddress(options?: Options.IsMACAddressOptions): Return;
   isMD5(): Return;
@@ -161,6 +161,7 @@ export interface Validators<Return> {
   isStrongPassword(options?: Options.IsStrongPasswordOptions): Return;
   isSurrogatePair(): Return;
   isTaxID(locale: Options.TaxIDLocale): Return;
+  isTime(options: Options.IsTimeOptions): Return;
   isURL(options?: Options.IsURLOptions): Return;
   isUUID(version?: Options.UUIDVersion): Return;
   isUppercase(): Return;

diff --git a/src/options.ts b/src/options.ts
@@ -920,6 +920,18 @@ export interface IsURLOptions {
   allow_query_components?: boolean;
 }
 
+/**
+ * defaults to
+ * {
+ *  hourFormat: 'hour24',
+ *  mode: 'default',
+ * };
+ */
+export interface IsTimeOptions {
+  hourFormat?: 'hour24' | 'hour12';
+  mode?: 'default' | 'withSeconds';
+}
+
 export interface NormalizeEmailOptions {
   all_lowercase?: boolean;
   gmail_lowercase?: boolean;