diff options
| author | Marak <[email protected]> | 2015-07-08 20:47:28 -0700 |
|---|---|---|
| committer | Marak <[email protected]> | 2015-07-08 20:47:28 -0700 |
| commit | e47ec6d722c3b9562569d82958f025c600b0d26c (patch) | |
| tree | 7562bfe7df2be75b1a538db0416eb8a30b97bc90 | |
| parent | 86a9de876646c1a08c0cf0dcf551aa9a73c1935e (diff) | |
| download | faker-e47ec6d722c3b9562569d82958f025c600b0d26c.tar.xz faker-e47ec6d722c3b9562569d82958f025c600b0d26c.zip | |
[docs] Update README
| -rw-r--r-- | Readme.md | 23 | ||||
| -rw-r--r-- | build/src/docs.md | 13 |
2 files changed, 36 insertions, 0 deletions
@@ -31,6 +31,19 @@ ## API +## Faker.fake() Generator + +As of version `v3.0.0` faker.js contains a super useful generator method for combining faker methods using a mustache string format. + +Example: + +```js +console.log(faker.fake(', ')); +// outputs: "Marks, Dean Sr." +``` + +This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()` + * address * zipCode * city @@ -48,6 +61,16 @@ * stateAbbr * latitude * longitude +* commerce + * color + * department + * productName + * price + * categories + * mergeCategories + * productAdjective + * productMaterial + * product * company * suffixes * companyName diff --git a/build/src/docs.md b/build/src/docs.md index 4f5aa7c0..6f5c3438 100644 --- a/build/src/docs.md +++ b/build/src/docs.md @@ -31,6 +31,19 @@ ## API +## Faker.fake() Generator + +As of version `v3.0.0` faker.js contains a super useful generator method for combining faker methods using a mustache string format. + +Example: + +```js +console.log(faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}')); +// outputs: "Marks, Dean Sr." +``` + +This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()` + {{{API}}} ## Localization |
