Skip to content

Commit 7cddded

Browse files
committed
[dist] Re-build library for v3.1.0 release
1 parent 5993a8a commit 7cddded

File tree

160 files changed

+586721
-30272
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+586721
-30272
lines changed

Readme.md

Lines changed: 58 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,22 @@ curl http://faker.hook.io?property=name.findName&locale=de
4545

4646
### Faker.fake()
4747

48-
As of version `v3.0.0` faker.js contains a super useful generator method `Faker.fake` for combining faker API methods using a mustache string format.
48+
faker.js contains a super useful generator method `Faker.fake` for combining faker API methods using a mustache string format.
4949

5050
**Example:**
5151

5252
``` js
53-
console.log(faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}'));
53+
console.log(faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}"));
5454
// outputs: "Marks, Dean Sr."
5555
```
5656

5757
This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()`
5858

59-
### API Methods
59+
### JSDoc API Browser
60+
61+
[http://marak.github.io/faker.js/](http://marak.github.io/faker.js/)
6062

61-
A documentation can be generated with `npm run-script doc`. The docs are put into `./doc`. Here is
62-
an overview of all api methods:
63+
### API Methods
6364

6465
* address
6566
* zipCode
@@ -115,6 +116,7 @@ an overview of all api methods:
115116
* currencyCode
116117
* currencyName
117118
* currencySymbol
119+
* bitcoinAddress
118120
* hacker
119121
* abbreviation
120122
* adjective
@@ -153,6 +155,7 @@ an overview of all api methods:
153155
* internet
154156
* avatar
155157
* email
158+
* exampleEmail
156159
* userName
157160
* protocol
158161
* url
@@ -165,11 +168,14 @@ an overview of all api methods:
165168
* mac
166169
* password
167170
* lorem
171+
* word
168172
* words
169173
* sentence
170174
* sentences
171175
* paragraph
172176
* paragraphs
177+
* text
178+
* lines
173179
* name
174180
* firstName
175181
* lastName
@@ -191,13 +197,29 @@ an overview of all api methods:
191197
* objectElement
192198
* uuid
193199
* boolean
200+
* word
201+
* words
202+
* image
203+
* locale
204+
* alphaNumeric
205+
* system
206+
* fileName
207+
* commonFileName
208+
* mimeType
209+
* commonFileType
210+
* commonFileExt
211+
* fileType
212+
* fileExt
213+
* directoryPath
214+
* filePath
215+
* semver
194216

195217

196218
## Localization
197219

198-
As of version `v2.0.0` faker.js supports over 27 different language definition packs.
220+
As of version `v2.0.0` faker.js has support for multiple localities.
199221

200-
The default language is set to English.
222+
The default language locale is set to English.
201223

202224
Setting a new locale is simple:
203225

@@ -209,7 +231,6 @@ faker.locale = "de";
209231
* de
210232
* de_AT
211233
* de_CH
212-
* el_GR
213234
* en
214235
* en_AU
215236
* en_BORK
@@ -225,6 +246,7 @@ faker.locale = "de";
225246
* fr
226247
* fr_CA
227248
* ge
249+
* id_ID
228250
* it
229251
* ja
230252
* ko
@@ -245,7 +267,7 @@ faker.locale = "de";
245267

246268
### Individual Localization Packages
247269

248-
As of version `v3.0.0` faker.js supports incremental loading of locales.
270+
As of vesion `v3.0.0` faker.js supports incremental loading of locales.
249271

250272
By default, requiring `faker` will include *all* locale data.
251273

@@ -279,27 +301,45 @@ See: https://github.com/lestoni/faker-cli
279301

280302
### Meteor
281303

282-
#### Meteor installation
304+
#### Meteor Installation
283305

284-
meteor add practicalmeteor:faker
306+
```
307+
meteor add practicalmeteor:faker
308+
```
285309

286-
#### meteor usage, both client and server
310+
#### Meteor Usage, both client and server
287311

288-
var randomName = faker.name.findName(); // Rowan Nikolaus
289-
var randomEmail = faker.internet.email(); // Kassandra.Haley@erich.biz
290-
var randomCard = faker.helpers.createCard(); // random contact card containing many properties
312+
```js
313+
var randomName = faker.name.findName(); // Rowan Nikolaus
314+
var randomEmail = faker.internet.email(); // Kassandra.Haley@erich.biz
315+
var randomCard = faker.helpers.createCard(); // random contact card containing many properties
316+
```
317+
318+
## Building faker.js
319+
320+
faker uses [gulp](http://gulpjs.com/) to automate it's build process. Running the following build command will generate new browser builds, documentation, and code examples for the project.
321+
322+
```
323+
npm run-script build
324+
```
325+
326+
## Building JSDocs
327+
328+
```
329+
npm run-script doc
330+
```
291331

292332
## Version Release Schedule
293333

294334
faker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible.
295335

296336
If you require the absolute latest version of `faker.js` the `master` branch @ https://github.com/marak/faker.js/ should always be up to date and working.
297337

298-
## Authors
338+
## Maintainer
299339

300-
#### Matthew Bergman & Marak Squires
340+
#### Marak Squires
301341

302-
faker.js - Copyright (c) 2014-2015
342+
faker.js - Copyright (c) 2016
303343
Matthew Bergman & Marak Squires
304344
https://github.com/marak/faker.js/
305345

0 commit comments

Comments
 (0)