@@ -89,23 +89,33 @@ A `rule` can be a regex string e.g.
8989- ` (connie|bob) ` which would generate 'connie' or 'bob'
9090- ` [1-9][0-9]{0,4} ` which would generate number between 1 and 99999
9191
92- A ` rule ` can also be a faker API call.
92+ A ` rule ` can also be a domain mapped faker API call.
9393
9494Faker API can be found here: https://fakerjs.dev/api/
9595
9696e.g.
9797
98- - ` faker.person.firstName `
99- - ` faker.hacker.noun `
98+ ```
99+ First Name
100+ awd.domain.person.firstName
101+
102+ Noun
103+ domain.hacker.noun
104+ ```
100105
101- The ` faker ` prefix is optional:
106+ The ` awd ` and ` domain ` prefixes are optional:
102107
103108e.g.
104109
105- - ` person.firstName `
106- - ` hacker.noun `
110+ ```
111+ First Name
112+ person.firstName
113+
114+ Noun
115+ hacker.noun
116+ ```
107117
108- The ` fake ` method is also supported, which takes a mustache template style string combining api methods e.g.
118+ The ` fake ` method on faker is also supported, which takes a mustache template style string combining api methods e.g.
109119
110120- ` helpers.fake("{{name.lastName}}, {{name.firstName}}") `
111121
@@ -118,7 +128,7 @@ helpers.fake("{{name.lastName}}, {{name.firstName}}")
118128
119129# profile text
120130desc
121- faker. lorem.paragraph
131+ lorem.paragraph
122132
123133# preference data
124134collects
@@ -165,8 +175,8 @@ There is a maintained list in the documentation:
165175
166176## Libraries Used
167177
168- - [ Faker.js] ( http ://marak.github.io/faker.js ) for domain api
169- - http ://marak.github.io/faker.js
178+ - [ Faker.js] ( https ://fakerjs.dev/ ) for backing the domain api
179+ - https ://fakerjs.dev/
170180- [ RandExp.js] ( http://fent.github.io/randexp.js/ ) for regular expression based random data generation
171181 - http://fent.github.io/randexp.js/
172182- [ Tabulator] ( https://tabulator.info/ ) for light weight tables
0 commit comments