Address review

express-validator · Jul 18, 2021 · c71a8a5 · c71a8a5
1 parent 36704ea
commit c71a8a5
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 10 deletions.
diff --git a/src/middlewares/__snapshots__/one-of.spec.ts.snap b/src/middlewares/__snapshots__/one-of.spec.ts.snap
@@ -63,7 +63,7 @@ Array [
 ]
 `;
 
-exports[`should let the user to choose between multiple error types legacy error type 1`] = `
+exports[`should let the user to choose between multiple error types flat error type 1`] = `
 Array [
   Object {
     "msg": "Invalid value(s)",

diff --git a/src/middlewares/one-of.spec.ts b/src/middlewares/one-of.spec.ts
@@ -140,7 +140,7 @@ describe('error message', () => {
 });
 
 describe('should let the user to choose between multiple error types', () => {
-  let errors: OneOfErrorType[] = ['grouped', 'legacy'];
+  let errors: OneOfErrorType[] = ['grouped', 'flat'];
   it.each(errors)(`%s error type`, async errorType => {
     const req: InternalRequest = {
       body: { foo: true },

diff --git a/src/middlewares/one-of.ts b/src/middlewares/one-of.ts
@@ -9,16 +9,19 @@ const dummyItem: ContextItem = { async run() {} };
 
 export type OneOfCustomMessageBuilder = (options: { req: Request }) => any;
 
-export type OneOfErrorType = 'grouped' | 'leastErroredOnly' | 'legacy';
-
-export interface OneOfOptions {
-  message?: OneOfCustomMessageBuilder | any;
-  errorType?: OneOfErrorType;
-}
+export type OneOfErrorType = 'grouped' | 'leastErroredOnly' | 'flat';
 
 export function oneOf(
   chains: (ValidationChain | ValidationChain[])[],
-  options: OneOfOptions = {},
+  options: { message: OneOfCustomMessageBuilder; errorType?: OneOfErrorType },
+): Middleware & { run: (req: Request) => Promise<void> };
+export function oneOf(
+  chains: (ValidationChain | ValidationChain[])[],
+  options: { message: any; errorType?: OneOfErrorType },
+): Middleware & { run: (req: Request) => Promise<void> };
+export function oneOf(
+  chains: (ValidationChain | ValidationChain[])[],
+  options = {},
 ): Middleware & { run: (req: Request) => Promise<void> } {
   options = { errorType: 'grouped', ...options };
 
@@ -63,7 +66,7 @@ export function oneOf(
             error = allErrors[leastErroredIndex];
             break;
           default:
-            // legacy
+            // flat
             error = _.flatMap(allErrors);
         }