index

Author: gsmithun4

README.md

@@ -18,21 +18,45 @@ Request field validator for expressjs
 <!-- **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)* -->
 
 - [Installation](#installation)
-- [Dependencies](#dependencies)
 - [How To Use](#how-to-use)
-- [validator arguments](#validator-arguments)
-  - [validator Object](#validator-object)
-    - [Nested Objets](#nested-objets)
-  - [Response object](#response-object)
-    - [Mode](#mode)
-      - [Reject](#reject)
-      - [Forward](#forward)
-    - [debug](#debug)
-- [checkService](#checkservice)
-  - [Usage](#usage)
-- [skipService](#skipservice)
-  - [Arguments](#arguments)
-  - [Usage](#usage-1)
+- [Getting Started](#getting-started)
+  - [Defining a Field](#defining-a-field)
+    - [Available Options](#available-options)
+      - [isRequired()](#isrequired)
+      - [isArray()](#isarray)
+      - [isObject()](#isobject)
+      - [isNumber()](#isnumber)
+      - [isEmail()](#isemail)
+      - [isBoolean()](#isboolean)
+      - [isDate()](#isdate)
+      - [dateFormat(format)](#dateformatformat)
+      - [minimumNumber(min)](#minimumnumbermin)
+      - [maximumNumber(max)](#maximumnumbermax)
+      - [minimumLength(min)](#minimumlengthmin)
+      - [maximumLength(max)](#maximumlengthmax)
+      - [shouldInclude(inclues)](#shouldincludeinclues)
+      - [shouldExclude(excludes)](#shouldexcludeexcludes)
+      - [isMobileNumberWithCountryCode(countryCode)](#ismobilenumberwithcountrycodecountrycode)
+      - [isMobileNumberWithCountryCodeMandatory()](#ismobilenumberwithcountrycodemandatory)
+      - [isMobileNumberWithMinimumLength(min)](#ismobilenumberwithminimumlengthmin)
+      - [isMobileNumberWithMaximumLength(max)](#ismobilenumberwithmaximumlengthmax)
+      - [addChild(child)](#addchildchild)
+      - [addChildren(children)](#addchildrenchildren)
+      - [sendErrorMessage(message)](#senderrormessagemessage)
+      - [end() :bangbang::bangbang: Mandatory](#end-bangbangbangbang-mandatory)
+  - [Creating a validation middleware](#creating-a-validation-middleware)
+    - [Available Options](#available-options-1)
+      - [isToBeRejected()](#istoberejected)
+      - [isToBeForwarded()](#istobeforwarded)
+        - [checkService](#checkservice)
+        - [skipService](#skipservice)
+      - [sendErrorCode(errorCode)](#senderrorcodeerrorcode)
+      - [debug(isDebugEnabled)](#debugisdebugenabled)
+      - [addParams(paramList)](#addparamsparamlist)
+      - [done() :bangbang::bangbang: Mandatory](#done-bangbangbangbang-mandatory)
+- [Dealing with nested objects](#dealing-with-nested-objects)
+  - [Request body](#request-body)
+  - [Validation](#validation)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->