typescript: move .custom() to shared typings

Closes express-validator#440

Author: markus-perl

check/index.d.ts

@@ -1,23 +1,17 @@
-import * as express from 'express';
-import { Result, Options, Validator } from '../shared-typings';
-
-export const check: ValidationChainBuilder;
-export const body: ValidationChainBuilder;
-export const cookie: ValidationChainBuilder;
-export const header: ValidationChainBuilder;
-export const param: ValidationChainBuilder;
-export const query: ValidationChainBuilder;
-export function validationResult (req: express.Request): Result;
-export function oneOf (chains: ValidationChain[]): express.RequestHandler;
-
-export interface ValidationChainBuilder {
-  (field: string | string[], message?: string): ValidationChain;
-}
-
-export interface ValidationChain extends express.RequestHandler, Validator {
-  custom(validator: CustomValidator): this;
-}
-
-export interface CustomValidator {
-  (value: any, options: { req: express.Request, location: string, path: string }): any;
-}
+import * as express from 'express';
+import { Result, Options, Validator } from '../shared-typings';
+
+export const check: ValidationChainBuilder;
+export const body: ValidationChainBuilder;
+export const cookie: ValidationChainBuilder;
+export const header: ValidationChainBuilder;
+export const param: ValidationChainBuilder;
+export const query: ValidationChainBuilder;
+export function validationResult (req: express.Request): Result;
+export function oneOf (chains: ValidationChain[]): express.RequestHandler;
+
+export interface ValidationChainBuilder {
+  (field: string | string[], message?: string): ValidationChain;
+}
+
+export interface ValidationChain extends express.RequestHandler, Validator {}

shared-typings.d.ts

@@ -1,3 +1,5 @@
+import * as express from 'express';
+
 export type URLProtocol = 'http' | 'https' | 'ftp'
 export type UUIDVersion = 3 | 4 | 5 | 'all'
 export type IPVersion = 4 | 6
@@ -114,6 +116,7 @@ export interface Validator extends Sanitizer {
   equals(equals: any): this;
   contains(str: string): this;
   matches(pattern: RegExp | string, modifiers?: string): this;
+  custom(validator: CustomValidator): this;
 
 
   // Additional ValidatorChain.prototype.* validators
@@ -177,6 +180,10 @@ export interface MappedError {
   location: Location
 }
 
+export interface CustomValidator {
+  (value: any, options: { req: express.Request, location: string, path: string }): any;
+}
+
 export interface Result {
   /**
    * @return A boolean determining whether there were errors or not.
@@ -295,6 +302,7 @@ declare namespace Options {
     equals?: ValidatorSchemaOptions
     contains?: ValidatorSchemaOptions
     matches?: ValidatorSchemaOptions
+    custom?: ValidatorSchemaOptions
   }
 
 

test/type-definition.spec.ts

@@ -123,6 +123,9 @@ app.use((req: express.Request, res: express.Response, next: express.NextFunction
 
 
   req.check('param', 'message')
+    .custom((value, { req, location, path }) => {
+      throw new Error([value, req.body.foo, location, path].join(' '));
+    })
     .isAwesomeLib()
     .isAsync()
     .isEmail().isEmail({ allow_display_name: true, allow_utf8_local_part: true, require_tld: true })