adding schema for internet.email

1 files changed, 22 insertions, 0 deletions

diff --git a/lib/internet.js b/lib/internet.js
index c9626a17..80b647fc 100644
--- a/lib/internet.js
+++ b/lib/internet.js
@@ -12,6 +12,28 @@ var Internet = function (faker) {
       return  faker.helpers.slugify(faker.internet.userName(firstName, lastName)) + "@" + provider;
   };
 
+  self.email.schema = {
+    "description": "Generates a valid email address based on optional input criteria",
+    "sampleResult": "[email protected]",
+    "properties": {
+      "firstName": {
+        "type": "string",
+        "required": false,
+        "description": "The first name of the user"
+      },
+      "lastName": {
+        "type": "string",
+        "required": false,
+        "description": "The last name of the user"
+      },
+      "provider": {
+        "type": "string",
+        "required": false,
+        "description": "The domain of the user"
+      }
+    }
+  };
+
   self.userName = function (firstName, lastName) {
       var result;
       firstName = firstName || faker.name.firstName();