aboutsummaryrefslogtreecommitdiff
path: root/build/src
diff options
context:
space:
mode:
authorMarak <[email protected]>2015-07-08 20:47:28 -0700
committerMarak <[email protected]>2015-07-08 20:47:28 -0700
commite47ec6d722c3b9562569d82958f025c600b0d26c (patch)
tree7562bfe7df2be75b1a538db0416eb8a30b97bc90 /build/src
parent86a9de876646c1a08c0cf0dcf551aa9a73c1935e (diff)
downloadfaker-e47ec6d722c3b9562569d82958f025c600b0d26c.tar.xz
faker-e47ec6d722c3b9562569d82958f025c600b0d26c.zip
[docs] Update README
Diffstat (limited to 'build/src')
-rw-r--r--build/src/docs.md13
1 files changed, 13 insertions, 0 deletions
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