diff options
| author | Marak Squires <[email protected]> | 2010-05-16 03:08:54 -0400 |
|---|---|---|
| committer | Marak Squires <[email protected]> | 2010-05-16 03:08:54 -0400 |
| commit | 92cc4ca9571804319c08dbc4688c6b15e2bee6fe (patch) | |
| tree | b69281a0c6cd6d7c6b86c27f8fdfbaa7d4d3c5bb | |
| parent | a40b92f509228f012c1607604efb2c98f49d8285 (diff) | |
| download | faker-92cc4ca9571804319c08dbc4688c6b15e2bee6fe.tar.xz faker-92cc4ca9571804319c08dbc4688c6b15e2bee6fe.zip | |
updating docs
| -rw-r--r-- | BUILD/docs.js | 5 | ||||
| -rw-r--r-- | BUILD/main.js | 30 | ||||
| -rw-r--r-- | Faker.js | 29 | ||||
| -rw-r--r-- | Readme.md | 4 |
4 files changed, 36 insertions, 32 deletions
diff --git a/BUILD/docs.js b/BUILD/docs.js index ac47cc63..a1641649 100644 --- a/BUILD/docs.js +++ b/BUILD/docs.js @@ -13,7 +13,7 @@ <script> var randomName = Faker.Name.findName(); // Caitlyn Kerluke var randomEmail = Faker.Internet.email(); // [email protected] - var randomCard = Faker.Helpers.createCard(); // contact card containing many properties + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties </script> ### node.js - @@ -22,10 +22,9 @@ var randomName = Faker.Name.findName(); // Rowan Nikolaus var randomEmail = Faker.Internet.email(); // [email protected] - var randomCard = Faker.Helpers.createCard(); // contact card containing many properties + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties - ## API {{{API}}} diff --git a/BUILD/main.js b/BUILD/main.js index d3e25feb..23993060 100644 --- a/BUILD/main.js +++ b/BUILD/main.js @@ -6,21 +6,25 @@ Faker.js - Written by Matthew Bergman and Marak Squires + + ## USAGE - USAGE: - - browser - - - <script src = "Faker.js" type = "text/javascript"></script> - <script> - var randomName = Faker.Name.findName(); - </script> - - node.js - - - var Faker = require(./Faker); - var randomName = Faker.Name.findName(); + ### browser - + + <script src = "Faker.js" type = "text/javascript"></script> + <script> + var randomName = Faker.Name.findName(); // Caitlyn Kerluke + var randomEmail = Faker.Internet.email(); // [email protected] + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties + </script> + + ### node.js - + + var Faker = require('./Faker'); + var randomName = Faker.Name.findName(); // Rowan Nikolaus + var randomEmail = Faker.Internet.email(); // [email protected] + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties */ @@ -1,22 +1,23 @@ -/*************** AUTOGENERATED @ 1273993594437 *************** +/*************** AUTOGENERATED @ 1273993732214 *************** WARNING: THIS FILE WAS AUTOGENERATED BY THE FAKER BUILD SCRIPT MODIFYING THIS FILE IS FINE, BUT YOU REALLY SHOULD BE MODIFYING THE LIBRARY DIRECTLY AND REGENERATING THIS FILE USING BUILD.js!!!! Faker.js - Written by Matthew Bergman and Marak Squires + + ## USAGE - USAGE: - - browser - - - <script src = "Faker.js" type = "text/javascript"></script> - <script> - var randomName = Faker.Name.findName(); - </script> - - node.js - - - var Faker = require(./Faker); - var randomName = Faker.Name.findName(); + ### browser - + <script src = "Faker.js" type = "text/javascript"></script> + <script> + var randomName = Faker.Name.findName(); // Caitlyn Kerluke + var randomEmail = Faker.Internet.email(); // [email protected] + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties + </script> + ### node.js - + var Faker = require('./Faker'); + var randomName = Faker.Name.findName(); // Rowan Nikolaus + var randomEmail = Faker.Internet.email(); // [email protected] + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties */ var Faker = {}; Faker.version = "0.0.1"; @@ -8,13 +8,13 @@ <script> var randomName = Faker.Name.findName(); // Caitlyn Kerluke var randomEmail = Faker.Internet.email(); // [email protected] - var randomCard = Faker.Helpers.createCard(); // contact card containing many properties + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties </script> ### node.js - var Faker = require('./Faker'); var randomName = Faker.Name.findName(); // Rowan Nikolaus var randomEmail = Faker.Internet.email(); // [email protected] - var randomCard = Faker.Helpers.createCard(); // contact card containing many properties + var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties ## API <ul><li>Name<ul><li>findName</li></ul></li><li>Address<ul><li>zipCode</li><li>city</li><li>streetName</li><li>streetAddress</li><li>secondaryAddress</li><li>ukCounty</li><li>ukCountry</li></ul></li><li>PhoneNumber<ul><li>phoneNumber</li></ul></li><li>Internet<ul><li>email</li><li>userName</li><li>domainName</li><li>domainWord</li></ul></li><li>Company<ul><li>companyName</li><li>companySuffix</li><li>catchPhrase</li><li>bs</li></ul></li><li>Lorem<ul><li>words</li><li>sentence</li><li>sentences</li><li>paragraph</li></ul></li><li>Helpers<ul><li>randomNumber</li><li>randomize</li><li>replaceSymbolWithNumber</li><li>shuffle</li><li>generateDataSet</li><li>createCard</li></ul></li><li>definitions<ul><li>first_name</li><li>last_name</li><li>name_prefix</li><li>name_suffix</li><li>us_state</li><li>us_state_abbr</li><li>city_prefix</li><li>city_suffix</li><li>street_suffix</li><li>uk_county</li><li>uk_country</li><li>catch_phrase_adjective</li><li>catch_phrase_descriptor</li><li>catch_phrase_noun</li><li>bs_adjective</li><li>bs_buzz</li><li>bs_noun</li><li>domain_suffix</li><li>lorem</li><li>phone_formats</li></ul></li></ul> |
